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 doc of non-deprecated macros from near-sdk-macros to reexport in near-sdk for continuous validation in ci #1288

Open
9 tasks
dj8yfo opened this issue Dec 28, 2024 · 1 comment
Labels

Comments

@dj8yfo
Copy link
Collaborator

dj8yfo commented Dec 28, 2024

documentation of all non-deprecated items of near-sdk-macros should be transferred to documentation
over re-export in near-sdk, e.g. https://github.com/near/near-sdk-rs/blob/master/near-sdk-macros/src/lib.rs#L46-L96 should be moved to near-sdk/src/lib.rs

/// ....
/// ...
pub use near_sdk_macros::near;

all

/// ```ignore

should be replaced with

/// ```no_run

or

/// ```rust

because it will allow to continuously check api, proposed in docs, for correctness in ci via test job https://github.com/near/near-sdk-rs/blob/master/.github/workflows/test.yml#L43 .

Doc in near-sdk-macros for these items will be empty (or a little msg with separator can be thrown in near/borsh-rs@46d7f65)
image
but it will be in near crate:
image

Tasks

Preview Give feedback
@dj8yfo
Copy link
Collaborator Author

dj8yfo commented Dec 28, 2024

mentioned above as one of subtasks
image

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