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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small typo in basic_usage.md, convert relative links #22

Merged
merged 1 commit into from Jan 26, 2022

Conversation

bcliden
Copy link
Contributor

@bcliden bcliden commented Jan 25, 2022

Hello 馃憢

I'm primarily submitting a small typo fix in basic_usage.md.

I was also reading the bare files in the repo and many of the relative links were broken due to the relative *.html links. I changed them to be primarily *.md links, which work when browsing the bare repo and will compile into correct html links when the book is built. Mdbook suggests relative *.md* links in their docs here: https://rust-lang.github.io/mdBook/format/markdown.html?highlight=link#links .I didn't touch any of the /docs/ links, since those aren't present in the repo before the build.

I tested each of my changes locally using the included ./docs_build.bat file and the links all routed correctly.

p.s. Thanks for this crate and it's wonderful documentation. I've really enjoyed reading through everything!

@@ -286,7 +286,7 @@ determine the absolute distance between numbers in those ranges:

This is why our addition was unexpectedly rounded up:

- `0.1` is in the range 0.0625 to 0.125, which are all `0.0625 f64::EPSILON` apart.
- `0.1` is in the range 0.0625 to 0.125, which are all `0.0625 * f64::EPSILON` apart.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the primary typo

@jtempest jtempest self-requested a review January 26, 2022 00:38
@jtempest
Copy link
Owner

Hello!

And thank you, I am glad that you like it. Nice catch, I didn't realise you could effectively read the mdbook on github itself, that's pretty neat. Apologies if it takes a moment for me to figure out how to process your PR, it's the first one I've ever had! :)

@jtempest jtempest removed their request for review January 26, 2022 00:59
@jtempest jtempest merged commit 0056fe5 into jtempest:main Jan 26, 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.

None yet

2 participants