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

ci: add a cargo doc job #1269

Merged
merged 2 commits into from
Dec 3, 2024
Merged

ci: add a cargo doc job #1269

merged 2 commits into from
Dec 3, 2024

Conversation

dj8yfo
Copy link
Collaborator

@dj8yfo dj8yfo commented Dec 2, 2024

resolves #1264

failed job due to warnings raised looks like this https://github.com/near/near-sdk-rs/actions/runs/12121010891/job/33791012532

@@ -1,3 +1,5 @@
//! Fungible tokens as described in [by the spec](https://nomicon.io/Standards/Tokens/FungibleToken).
Copy link
Collaborator Author

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
image
rendered correctly vs
image
at https://docs.rs/near-contract-standards/5.6.0/near_contract_standards/fungible_token/index.html

@dj8yfo dj8yfo marked this pull request as ready for review December 2, 2024 16:44
Copy link

codecov bot commented Dec 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.20%. Comparing base (da3f1f4) to head (3de9b54).
Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

@dj8yfo
Copy link
Collaborator Author

dj8yfo commented Dec 2, 2024

@race-of-sloths include

@race-of-sloths
Copy link

race-of-sloths commented Dec 2, 2024

@dj8yfo Thank you for your contribution! Your pull request is now a part of the Race of Sloths!

Shows inviting banner with latest news.

Shows profile picture for the author of the PR

Current status: executed
Reviewer Score
@akorchyn 5

Your contribution is much appreciated with a final score of 5!
You have received 58 (50 base + 15% lifetime bonus) Sloth points for this contribution

@akorchyn received 25 Sloth Points for reviewing and scoring this pull request.

What is the Race of Sloths

Race 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:

  • Tag @race-of-sloths inside your pull requests
  • Wait for the maintainer to review and score your pull request
  • Check out your position in the Leaderboard
  • Keep weekly and monthly streaks to reach higher positions
  • Boast your contributions with a dynamic picture of your Profile

For maintainers:

  • Score pull requests that participate in the Race of Sloths and receive a reward
  • Engage contributors with fair scoring and fast responses so they keep their streaks
  • Promote the Race to the point where the Race starts promoting you
  • Grow the community of your contributors

Feel free to check our website for additional details!

Bot commands
  • For contributors
    • Include a PR: @race-of-sloths include to enter the Race with your PR
  • For maintainers:
    • Invite contributor @race-of-sloths invite to invite the contributor to participate in a race or include it, if it's already a runner.
    • Assign points: @race-of-sloths score [1/2/3/5/8/13] to award points based on your assessment.
    • Reject this PR: @race-of-sloths exclude to send this PR back to the drawing board.
    • Exclude repo: @race-of-sloths pause to stop bot activity in this repo until @race-of-sloths unpause command is called

@@ -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,
Copy link
Collaborator

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 ...

Copy link
Collaborator Author

@dj8yfo dj8yfo Dec 3, 2024

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)

@akorchyn
Copy link
Collaborator

akorchyn commented Dec 3, 2024

@race-of-sloths score 5

@dj8yfo dj8yfo merged commit 5a4c595 into near:master Dec 3, 2024
39 checks passed
@frol frol mentioned this pull request Dec 3, 2024
This was referenced Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: create a github actions job to check docs generated for warnings
3 participants