search

A03ki / uecbbs

@uec_bbsを支えるPythonパッケージTwissifyの管理
https://twitter.com/uec_bbs
MIT License
0 stars 0 forks source link

Sphinxを導入する前にdocstringの修正 #30

Closed A03ki closed 4 years ago

A03ki commented 4 years ago

Docstringにおいて変数を``で囲っているので、正しく表示できるように修正する。 正しい書き方は以下に記した。

インラインコードの書き方

インラインコードを書くときは

`test`

ではなく

``test``

とする。

注意点

文中で使うときは両側に空白を入れる。そのため、

その``test``が...

ではなく

その ``test`` が...

とする。

参考文献

reStructuredText入門 — Sphinx 4.0.0+/3c7d35d2a ドキュメント NumPyスタイルPython Docstringsの例 — Sphinx 4.0.0+/3c7d35d2a ドキュメント

Originally posted by @A03ki in https://github.com/A03ki/uecbbs/issues/29#issuecomment-632628322

A03ki commented 4 years ago

バッククオートで囲っていない部分を見つけたので修正する。

A03ki commented 4 years ago

api.pyにあるis_photoのNotesの書き方がNumpyスタイルではないので修正する。

この変更は #32 で行う。