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.

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

Incomplete documentation for aarch64 specific components #133

Open
binoychitale opened this issue Jan 21, 2021 · 4 comments
Open

Incomplete documentation for aarch64 specific components #133

binoychitale opened this issue Jan 21, 2021 · 4 comments
Labels
help wanted Extra attention is needed

Comments

@binoychitale
Copy link

I observed that in the documentation on docs.rs, certain methods that are specific to non-x86 build targets are not rendered on the documentation page.

The build documentation on docs.rs states that the default compilation target is x86_64-unknown-linux-gnu, which probably leads to the missing documentation for aarch64 specific components.

If I'm not wrong, adding the #[cfg(docsrs)] annotation to all public methods would fix this, as documented here

@andreeaflorescu
Copy link
Member

@binoychitale thanks for reporting this. I was living with the impression that aarch64 documentation examples are not supported by docs.rs. Do you happen to also have an example of a crate that also renders aarch64 documentation so that we can look at how they're configuring it?

@binoychitale
Copy link
Author

Unfortunately I don't have an example.
I just came across the issue while digging through the docs for this crate

@andreeaflorescu
Copy link
Member

I tried adding #![cfg(docsrs)] and the documentation was not rendered at all. I am not sure how this works.

@binoychitale
Copy link
Author

I did find this PR in which something similar is done, except that it is for documenting all features instead of all architectures

@andreeaflorescu andreeaflorescu added the help wanted Extra attention is needed label Feb 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants