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

Add readme-sync #31

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add readme-sync #31

wants to merge 1 commit into from

Conversation

daxpedda
Copy link
Collaborator

@daxpedda daxpedda commented Jan 4, 2022

This makes sure our README and documentation in lib.rs are in sync. I also added a WRITE_README=1 environment variable to the test, so we can just update the README instead of manually syncing them by hand.

Remaining issues:

@ModProg
Copy link
Owner

ModProg commented Jan 5, 2022

Running cargo test readme_sync twice with WRITE_README=1 fails on:

`Text("([#27]):")`
 does not match docs node
`Text("(")`
  --> README.md:12:1
   |
12 | ([\#27]):
   | ^^ ^^^^^^
   |
  ::: src/lib.rs/parsed
   |
10 |  ([#27]):
   |  ^
   |
  ::: src/lib.rs
   |
16 | //! ([#27]):
   | ------------

non-msrv-tests/src/lib.rs Show resolved Hide resolved
@daxpedda
Copy link
Collaborator Author

daxpedda commented Jan 5, 2022

We will see how the issues I linked above get resolved, but I don't personally have time to do it myself.

I consider the linking issue blocking, the issue with weird output when writing can be ignored, the whole writing part can be removed, checking if both are in sync is still useful and works correctly.

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