Skip to content
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

Jump to bottom

Add doc(alias) to functions #1673

Closed
euclio opened this issue Mar 12, 2022 · 1 comment · Fixed by #1693
Closed

Add doc(alias) to functions #1673

euclio opened this issue Mar 12, 2022 · 1 comment · Fixed by #1693

Comments

@euclio
Copy link
Contributor

euclio commented Mar 12, 2022

I had some trouble finding User::from_uid and Uid::current when looking for getpwuid and getuid replacements. It would be nice to add some doc aliases for the underlying C function names so that a library user can search the C function name and find the corresponding Rust function.

Unfortunately this feature was stabilized in 1.48 so we will have to wait for a MSRV bump to do it.
@asomers
Copy link
Member

asomers commented Mar 12, 2022

That's a good idea.

@asomers asomers mentioned this issue Mar 12, 2022
Closed
@rtzoeller rtzoeller mentioned this issue Apr 8, 2022
Merged
bors bot added a commit that referenced this issue Jun 24, 2022
@bors @rtzoeller
Merge #1693
08110dc 
1693: Document aliases for functions like getuid() r=asomers a=rtzoeller

Add the autocfg crate as a build dependency, and introduce `has_doc_alias` as a conditional compilation symbol.

Closes #1673.

Co-authored-by: Ryan Zoeller <rtzoeller@rtzoeller.com>
@bors bors bot closed this as completed in 0922fd9 Jun 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document aliases for functions like getuid() rtzoeller/nix
2 participants
@asomers @euclio