Skip to content

Commit a8a5c45

Browse files
committed
docs: Add a reference to common docstring format and remove outdated next steps
1 parent 49ce8ef commit a8a5c45

1 file changed

Lines changed: 2 additions & 9 deletions

File tree

docs/how-much-docstring-is-enough.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -133,17 +133,10 @@ Before you write a docstring, ask:
133133

134134
---
135135

136+
**See also:** [Common Docstring Format in Python](./docs/common-docstring-format-in-python.md)
137+
136138
## 💡 Final Thoughts
137139

138140
Writing good docstrings is like leaving clues for future developers — and for your own future self. The goal isn't to **document everything**, but to **document what matters**.
139141

140142
📌 **Good code tells how. Good docs tell why.**
141-
142-
---
143-
144-
**Next Step**: Want a ready-to-use Python docstring template file for your projects?
145-
Let me know — I’ll send you one!
146-
147-
---
148-
149-
Would you like this in Markdown or HTML format for your blog or dev portfolio?

0 commit comments

Comments
 (0)