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: create a github actions job to check docs generated for warnings #1264

Open
dj8yfo opened this issue Nov 26, 2024 · 1 comment
Open

Comments

@dj8yfo
Copy link
Collaborator

dj8yfo commented Nov 26, 2024

it should run RUSTDOCFLAGS="-D warnings" cargo doc -p near-sdk --features unstable,legacy,unit-testing,__macro-docs
and some broken links should be fixed.

near-sdk-macros doc generation should be checked too

@dj8yfo
Copy link
Collaborator Author

dj8yfo commented Nov 26, 2024

it was noticed in scope of #1259, if new intra-doc links are added , they will be automatically detected for being broken (if they are),
via RUSTDOCFLAGS="-D warnings"

error: unresolved link to `ear_vm_runner::logic::VMLogic::promise_batch_action_function_call_weight`
   --> near-sdk/src/environment/env.rs:998:50
    |
998 | ...t [ear_vm_runner::logic::VMLogic::promise_batch_action_function_call_weight]
    |       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `ear_vm_runner` in scope
    |
    = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`

@dj8yfo dj8yfo added the docs label Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: NEW❗
Development

No branches or pull requests

1 participant