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

Fixed broken links in Readme and rust docs warning. #162

Merged
merged 1 commit into from
Nov 11, 2023

Conversation

BoolPurist
Copy link
Contributor

Changes

  • Fixed warnings previously emitted by command cargo doc.
  • Fixed some spelling.
  • Fixed a few links for Github in README by prefixing them with a leading "/". Without those leading slashes the links produce a file not found aka 404 error.

Note

In file bevy_asset_loader/src/dynamic_asset.rs at line 446 I replaced the link to struct which is only visible within the crate, with just the word state. This change fixes a warning produced by the command:

cargo doc --all-features

and prevents leaking an inner detail which is not relevant to an user of the crate.

@NiklasEi
Copy link
Owner

NiklasEi commented Nov 9, 2023

Hey, thank you 🙂
The readme links without leading slash were an experiment for #113, but I clearly forgot that you can read the Readme on the base of the repository (here the links work) and in the bevy_asset_loader directory (here they are broken).

@BoolPurist BoolPurist force-pushed the fix_broken_links branch 3 times, most recently from e3f6057 to 71ff7e2 Compare November 10, 2023 03:48
@BoolPurist
Copy link
Contributor Author

"This is actually British English vs American English. I think I prefer British (so initialise)."
Fair enough. I reverted the spelling back to British variant.

Fixed a few links in README

Co-authored-by: Niklas Eicker <git@nikl.me>
Copy link
Owner

@NiklasEi NiklasEi left a comment

Choose a reason for hiding this comment

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

Thanks again 🙂

@NiklasEi NiklasEi merged commit 02b711f into NiklasEi:main Nov 11, 2023
10 checks passed
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.

2 participants