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

WIP: Basic doc upgrades #22

Closed
wants to merge 1 commit into from
Closed

WIP: Basic doc upgrades #22

wants to merge 1 commit into from

Conversation

Owez
Copy link

@Owez Owez commented Jun 10, 2020

For #21

Some basic documentation documentation upgrades for meta items that generally aren't each specific sentence struct {} themself.

@codecov
Copy link

codecov bot commented Jun 10, 2020

Codecov Report

Merging #22 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #22   +/-   ##
=======================================
  Coverage   85.31%   85.31%           
=======================================
  Files           9        9           
  Lines         885      885           
=======================================
  Hits          755      755           
  Misses        130      130           
Impacted Files Coverage Δ
src/lib.rs 81.75% <ø> (ø)

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 3f869b6...03bc65e. Read the comment docs.

@Dushistov
Copy link
Collaborator

Looks like cargo rustdoc can not resolve some links.

@Owez
Copy link
Author

Owez commented Jun 10, 2020

Yeah, noticed that when testing. Happened on one of my personal crates also for a while.

@Owez
Copy link
Author

Owez commented Sep 23, 2020

@Dushistov Seems like that issue was due to nightly not being enabled on our local machines whilst testing. If you do cargo +nightly doc, should resolve links. docs.rs uses a nightly compiler

@Dushistov
Copy link
Collaborator

@Owez

Seems like that issue was due to nightly not being enabled on our local machines whilst testing. If you do cargo +nightly doc,
should resolve links. docs.rs uses a nightly compiler

Not sure what do you mean here. I did not test your PR. The testing is run automatically on each PR.
For broken links testing it uses current nightly compiler. You can run it locally via cargo +nightly rustdoc -- -D warnings.
You can see error that it found here: https://github.com/AeroRust/nmea/pull/22/files .

For example [nmea::Nmea::parse] should be [Nmea::parse]

@Owez
Copy link
Author

Owez commented Sep 23, 2020

Ah, apologies. I thought you meant rustdoc not generating links on stable

@elpiel
Copy link
Member

elpiel commented Jul 16, 2022

Closing in favour of #43

@elpiel elpiel closed this Jul 16, 2022
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.

3 participants