nakada0907/n-daisuke897-blog
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Compare commits

base: nakada0907:f1a673970a98b630980383dc34abf1590dcd680e
Branches Tags
nakada0907:main
nakada0907:develop
..
compare: nakada0907:1bd79e9caaf188a6ff9a69a334c07e2d26c80eee
Branches Tags
nakada0907:main
nakada0907:develop

2 commits
f1a673970a ... 1bd79e9caa

Author SHA1 Message Date
Daisuke
1bd79e9caa Add line-height in markdown-content 2025-05-16 20:38:52 +09:00
Daisuke
777451fc89 Add an article on Docstring 2025-05-16 20:33:16 +09:00
2 changed files with 20 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/blog/post-3.md Normal file
View file

@ -0,0 +1,14 @@
---
title: 'Why I Write Docstrings'
pubDate: 2025-05-16
author: 'Nakahara Daisuke'
tags: ["programming"]
---
I try to write docstrings as much as possible for two main reasons.
First, they help reviewers understand the roles of functions and classes.
Second, I believe that clear, detailed docstrings can enable AI tools to generate code more effectively.
Although I sometimes make mistakes in my docstrings,
I think that even imperfect documentation is better than none.
Moreover, both reviewers and AI tools can help identify and correct these errors.

11
src/layouts/MarkdownPostLayout.astro
View file

@ -48,18 +48,19 @@ const optionsForDate = {
}
.markdown-content {
font-family: sans-serif;
font-size: 1.2rem;
font-family: sans-serif;
font-size: 1.2rem;
line-height: 2.5;
}
.markdown-content h1 {
font-size: 1.9rem;
font-size: 1.9rem;
}
.markdown-content h2 {
font-size: 1.75rem;
font-size: 1.75rem;
}
.markdown-content h3 {
font-size: 1.5rem;
font-size: 1.5rem;
}
</style>