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

Fix broken intra-doc links + add CI stage to test example docs #606

Merged
merged 19 commits into from
Feb 2, 2021

Conversation

cmichi
Copy link
Collaborator

@cmichi cmichi commented Dec 7, 2020

You can verify for yourself by executing

  • cargo doc --workspace --document-private-items --verbose --no-deps in ink/ or

  • cargo doc --manifest-path=Cargo.toml --document-private-items --verbose --no-deps in an example folder.

During the issue I discovered a bug in rustdoc.

@codecov-io
Copy link

codecov-io commented Dec 7, 2020

Codecov Report

Merging #606 (d65b466) into master (5115146) will decrease coverage by 15.54%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           master     #606       +/-   ##
===========================================
- Coverage   83.75%   68.21%   -15.55%     
===========================================
  Files         156      156               
  Lines        6969     6969               
===========================================
- Hits         5837     4754     -1083     
- Misses       1132     2215     +1083     
Impacted Files Coverage Δ
crates/env/src/backend.rs 0.00% <ø> (ø)
crates/env/src/engine/off_chain/db/block.rs 100.00% <ø> (ø)
crates/lang/codegen/src/generator/cross_calling.rs 0.00% <ø> (-94.00%) ⬇️
crates/storage/src/collections/bitstash/mod.rs 97.91% <ø> (ø)
crates/storage/src/collections/smallvec/mod.rs 96.47% <ø> (ø)
crates/storage/src/collections/stash/mod.rs 96.81% <ø> (ø)
crates/storage/src/collections/vec/mod.rs 96.77% <ø> (ø)
crates/storage/src/lazy/entry.rs 94.73% <ø> (ø)
crates/storage/src/lazy/lazy_hmap.rs 93.77% <ø> (ø)
crates/lang/codegen/src/traits.rs 0.00% <0.00%> (-100.00%) ⬇️
... and 36 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5115146...d65b466. Read the comment docs.

@cmichi cmichi requested a review from Robbepop December 7, 2020 12:30
.gitlab-ci.yml Show resolved Hide resolved
crates/storage/src/collections/stash/mod.rs Outdated Show resolved Hide resolved
crates/storage/src/lazy/lazy_hmap.rs Outdated Show resolved Hide resolved
@cmichi
Copy link
Collaborator Author

cmichi commented Jan 29, 2021

On my machine the latest rustc nightly (from yesterday) results in this ICE when executing cargo doc --workspace --verbose --no-deps in ink/: rust-lang/rust#81395. There are no issues in our CI though, since it uses the nightly from 2021-01-07.

I would hold merging this PR until the ICE is fixed.

@jryans
Copy link

jryans commented Feb 1, 2021

I would hold merging this PR until the ICE is fixed.

The 2021-02-01 nightly includes a fix for this.

crates/storage/src/collections/smallvec/mod.rs Outdated Show resolved Hide resolved
examples/dns/lib.rs Outdated Show resolved Hide resolved
Copy link
Collaborator

@Robbepop Robbepop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry for being so pedantic but simply accept my suggestions and we are good to merge

crates/storage/src/collections/bitstash/mod.rs Outdated Show resolved Hide resolved
crates/storage/src/collections/bitstash/mod.rs Outdated Show resolved Hide resolved
crates/storage/src/collections/smallvec/mod.rs Outdated Show resolved Hide resolved
crates/storage/src/collections/stash/mod.rs Outdated Show resolved Hide resolved
crates/storage/src/collections/vec/mod.rs Outdated Show resolved Hide resolved
crates/storage/src/lazy/entry.rs Outdated Show resolved Hide resolved
crates/storage/src/lazy/entry.rs Outdated Show resolved Hide resolved
crates/storage/src/lazy/entry.rs Outdated Show resolved Hide resolved
crates/storage/src/lazy/entry.rs Outdated Show resolved Hide resolved
crates/storage/src/lazy/lazy_hmap.rs Outdated Show resolved Hide resolved
Co-authored-by: Hero Bird <robin.freyler@gmail.com>
Copy link
Collaborator

@Robbepop Robbepop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@cmichi cmichi merged commit 7aaf4dc into master Feb 2, 2021
@cmichi cmichi deleted the cmichi-fix-broken-intra-doc-links branch February 2, 2021 14:28
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.

4 participants