Skip to content

Turns out doc(cfg()) is not the valid way to hide cfg from docs #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 23, 2024
Merged

Turns out doc(cfg()) is not the valid way to hide cfg from docs #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87ef8e4
Turns out doc(cfg()) is not the valid way to hide cfg from docs
HadrienG2 Feb 23, 2024
ef0fdd0
Will need an extra tag to fix the docs.rs build
HadrienG2 Feb 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ overflow-checks = false

[package]
name = "hwlocality"
version = "1.0.0-alpha.2"
version = "1.0.0-alpha.3"
authors.workspace = true
edition.workspace = true
rust-version.workspace = true
Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ pub type ThreadId = hwloc_thread_t;

/// Get the current thread's identifier through the libc or windows API
#[cfg(not(target_os = "windows"))]
#[cfg_attr(docsrs, doc(cfg()))]
#[cfg_attr(docsrs, doc(cfg(all())))]
pub fn current_thread_id() -> ThreadId {
// SAFETY: Should be always safe to call
let id = unsafe { libc::pthread_self() };
Expand All @@ -279,7 +279,7 @@ pub fn current_thread_id() -> ThreadId {
//
/// Get the current thread's identifier through the libc or windows API
#[cfg(target_os = "windows")]
#[cfg_attr(docsrs, doc(cfg()))]
#[cfg_attr(docsrs, doc(cfg(all())))]
pub fn current_thread_id() -> ThreadId {
// SAFETY: Should be always safe to call on Windows
unsafe { windows_sys::Win32::System::Threading::GetCurrentThread() }
Expand Down