-
Notifications
You must be signed in to change notification settings - Fork 248
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
ci: add a cargo doc
job
#1269
ci: add a cargo doc
job
#1269
Conversation
f98a308
to
e82ffcc
Compare
f42ad33
to
3de9b54
Compare
@@ -1,3 +1,5 @@ | |||
//! Fungible tokens as described in [by the spec](https://nomicon.io/Standards/Tokens/FungibleToken). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this change somehow results in this section
rendered correctly vs
at https://docs.rs/near-contract-standards/5.6.0/near_contract_standards/fungible_token/index.html
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1269 +/- ##
=======================================
Coverage 80.20% 80.20%
=======================================
Files 102 102
Lines 14598 14598
=======================================
Hits 11708 11708
Misses 2890 2890 ☔ View full report in Codecov by Sentry. |
@race-of-sloths include |
@dj8yfo Thank you for your contribution! Your pull request is now a part of the Race of Sloths! Current status: executed
Your contribution is much appreciated with a final score of 5! @akorchyn received 25 Sloth Points for reviewing and scoring this pull request. What is the Race of SlothsRace of Sloths is a friendly competition where you can participate in challenges and compete with other open-source contributors within your normal workflow For contributors:
For maintainers:
Feel free to check our website for additional details! Bot commands
|
@@ -52,7 +52,7 @@ | |||
//! - [`UnorderedMap`]: Storage version of [`std::collections::HashMap`]. No ordering | |||
//! guarantees. | |||
//! | |||
//! - [`TreeMap`](TreeMap) (`unstable`): Storage version of [`std::collections::BTreeMap`]. Ordered by key, | |||
//! - [`TreeMap`] (`unstable`): Storage version of [`std::collections::BTreeMap`]. Ordered by key, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it should be the full path to TreeMap but I'm not an expert in rustdoc...
(At least for me, it displays the warning)
warning: unresolved link to `TreeMap`
--> near-sdk/src/store/mod.rs:55:9
|
55 | //! - [`TreeMap`] (`unstable`): Storage version of [`std::collections::BTreeMap`]. Ordered ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this needs --features unstable
suffix to cmd, otherwise it's referenced from doc, but not present in code.
probably that 's the reason....
also the behaviour slightly changes with toolchain version
❯ : rustdoc --version
rustdoc 1.83.0 (90b35a623 2024-11-26)
@race-of-sloths score 5 |
resolves #1264
failed job due to warnings raised looks like this https://github.com/near/near-sdk-rs/actions/runs/12121010891/job/33791012532