Skip to content

Commit

Permalink
docs: README.md improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
drahnr committed Jun 3, 2020
1 parent 82c13c0 commit 5dc7702
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ Error display follows `cargo` error printing style:
* [x] Merge multiline doc comments
* [x] Grammar check using `languagetool` http API
* [x] False positive reduction
* [x] Be `markdown` aware
* [ ] Include doctests ( ` ```rust` code wrapped sections)
* [x] Handle module documentation comments
* [ ] Add `README.md` files
* [x] Follow module declarations rather than blindly recurse
* [ ] Handle cargo workspaces
* [ ] `cargo-spellcheck fix`
* [x] Be `markdown` aware
* [ ] Hande doctests with ` ```rust` as virtual files, removing the `#` for hidden lines.
* [ ] Verify all types of links: direct urls and href
* [ ] Check `README.md` files (either [skeptic-like](https://github.com/budziq/rust-skeptic/blob/master/src/skeptic/lib.rs#L240-L259) which would be straight forward, or add an example using [doc-comment](https://crates.io/crates/doc-comment))
* [ ] `cargo-spellcheck fix --interactive`
* [ ] `cargo-spellcheck fix`
* [ ] Handle cargo workspaces
* [ ] Re-wrap doc comments
* [ ] Word split validation

Expand Down

0 comments on commit 5dc7702

Please sign in to comment.