derive-where icon indicating copy to clipboard operation
derive-where copied to clipboard

Add readme-sync

Open daxpedda opened this issue 3 years ago • 2 comments

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:

  • Currently links are a bit broken, see zheland/readme-sync#1, the workaround currently requires to specify links in lib.rs that aren't really necessary.
  • Currently writing the README doesn't produce perfect output, see zheland/readme-sync#2.

daxpedda avatar Jan 04 '22 11:01 daxpedda

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]):
   | ------------

ModProg avatar Jan 05 '22 10:01 ModProg

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.

daxpedda avatar Jan 05 '22 10:01 daxpedda