Update README, more renaming #29
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This also fixes the documentation links from axohtml_macros to axohtml.
5334d78 and c036b7c were only applied to the crate documentation but not to the copy in README.md. Might make sense to use https://github.com/livioribeiro/cargo-readme or https://github.com/orium/cargo-rdme ;)
ashleygwilliams
approved these changes
Mar 24, 2023
There was a problem hiding this comment.
oh wow. this is really great @adrianheine - thank you so much. i think i'll also add doc tests to this repo! (it was a fork of a project that is no longer maintained! which is why a lot of the renaming happened)
|
Great that you like the changes :) I just added two commits, one syncing the crate docs with changes you made to README.md and the other using those nice intra-doc links. |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This mixed-bag pull request is mostly about fixing the broken links in the README file, but on my way I also came across broken code examples in the README, wrong links and places where
typed-htmlwas still used. Even though the PR itself is a bit messy, the three issues (linkfixes in README, crate renaming, update README) each have their own, nice commits.