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

doc: move body of examples from near (gated under __macro_docs feature) module to #[near] macro doc (with link) #1289

Open
8 tasks
dj8yfo opened this issue Dec 28, 2024 · 2 comments
Labels

Comments

@dj8yfo
Copy link
Collaborator

dj8yfo commented Dec 28, 2024

Body of all sub-attributes/annotations docs in https://docs.rs/near-sdk/5.7.0/near_sdk/near/index.html has
to be moved to documentation of https://docs.rs/near-sdk/5.7.0/near_sdk/attr.near.html ,
and links to new place left via #anchors

using rust-lang/rust#62833

/// See [`near_sdk::near #[init]`](macro@crate::near#init-sub-attribute)

image

Thus individual sub-attributes/annotations will remain searchable
image

but the documentation for all about #[near] macro will be on https://docs.rs/near-sdk/5.7.0/near_sdk/attr.near.html page

Tasks

Preview Give feedback
@dj8yfo dj8yfo added the docs label Dec 28, 2024
@github-project-automation github-project-automation bot moved this to NEW❗ in DevTools Dec 28, 2024
@dj8yfo dj8yfo changed the title doc: move body of examples from near __macro_docs module to #[near] macro doc (with link) doc: move body of examples from near (gated under __macro_docs feature) module to #[near] macro doc (with link) Dec 28, 2024
@dj8yfo
Copy link
Collaborator Author

dj8yfo commented Dec 28, 2024

this in conjunction with #1288 might improve overall structure of rustdocs regarding #[near] macro,
allowing to keep it up-to-date and possibly adding other, yet undocumented sub-attributes

@dj8yfo
Copy link
Collaborator Author

dj8yfo commented Dec 28, 2024

this is mutually exclusive with #1287, so closing #1287

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: NEW❗
Development

No branches or pull requests

1 participant