Skip to content

Commit b05a41a

Browse files
committed
Update documentation
1 parent 4a16088 commit b05a41a

File tree

3 files changed

+15
-1
lines changed

3 files changed

+15
-1
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ The corresponding Github repository of _pydoclint_ is:
5656
- [3. Style violation codes](#3-style-violation-codes)
5757
- [4. Additional notes for users](#4-additional-notes-for-users)
5858
- [5. Notes for developers](#5-notes-for-developers)
59+
- [6. Miscellaneous notes](#6-miscellaneous-notes)
5960

6061
<!--TOC-->
6162

@@ -222,3 +223,9 @@ If you'd like to contribute to the code base of _pydoclint_, thank you!
222223

223224
[This guide](https://jsh9.github.io/pydoclint/notes_for_developers.html) can
224225
hopefully help you get familiar with the code base faster.
226+
227+
## 6. Miscellaneous notes
228+
229+
- [Checking class attributes](https://jsh9.github.io/pydoclint/checking_class_attributes.html)
230+
- [Notes on `Generator` vs `Iterator`](https://jsh9.github.io/pydoclint/notes_generator_vs_iterator.html)
231+
- [More about docstring style mismatch (`DOC003`)](https://jsh9.github.io/pydoclint/style_mismatch.html)

docs/index.md

+7
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ The corresponding Github repository of _pydoclint_ is:
5656
- [3. Style violation codes](#3-style-violation-codes)
5757
- [4. Additional notes for users](#4-additional-notes-for-users)
5858
- [5. Notes for developers](#5-notes-for-developers)
59+
- [6. Miscellaneous notes](#6-miscellaneous-notes)
5960

6061
<!--TOC-->
6162

@@ -222,3 +223,9 @@ If you'd like to contribute to the code base of _pydoclint_, thank you!
222223

223224
[This guide](https://jsh9.github.io/pydoclint/notes_for_developers.html) can
224225
hopefully help you get familiar with the code base faster.
226+
227+
## 6. Miscellaneous notes
228+
229+
- [Checking class attributes](https://jsh9.github.io/pydoclint/checking_class_attributes.html)
230+
- [Notes on `Generator` vs `Iterator`](https://jsh9.github.io/pydoclint/notes_generator_vs_iterator.html)
231+
- [More about docstring style mismatch (`DOC003`)](https://jsh9.github.io/pydoclint/style_mismatch.html)

docs/notes_for_users.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ To use this feature, you only need to generate a "baseline violations" file
188188
somewhere in your repo.
189189

190190
For more details, please check out
191-
[this section](https://jsh9.github.io/pydoclint/config_options.html#12---baseline).
191+
[this section](https://jsh9.github.io/pydoclint/config_options.html#20---baseline).
192192

193193
## 7. How to integrate _pydoclint_ with different editors or IDEs
194194

0 commit comments

Comments
 (0)