... ートフィルタの docstring からドキュメントを取り出し、 Django admin から利用できるようにします。 概要 ¶ admindocs を有効にするには、以下のようにしま ... ント" リンクをクリックすれば、ドキュメントを読むことができます。 ドキュメンテーション・ヘルパー ¶ 以下の特別なマークアップをdocstringで使用することで、他のコンポーネントへのハイパーリンクを簡単に作成できます: Django コンポーネント reStructuredText のロール ... す。他のモデルとのリレーションはハイパーリンクとして表示されます。説明文は、フィールドの help_text 属性や、モデルメソッドの docstring から取得されます。 役に立つドキュメントを持ったモデルは次のようなものです: class BlogEntry ( models . Model ): """ Stores ... ... ートフィルタの docstring からドキュメントを取り出し、 Django admin から利用できるようにします。 概要 ¶ admindocs を有効にするには、以下のようにしま ... ント" リンクをクリックすれば、ドキュメントを読むことができます。 ドキュメンテーション・ヘルパー ¶ 以下の特別なマークアップをdocstringで使用することで、他のコンポーネントへのハイパーリンクを簡単に作成できます: Django コンポーネント reStructuredText のロール ... す。他のモデルとのリレーションはハイパーリンクとして表示されます。説明文は、フィールドの help_text 属性や、モデルメソッドの docstring から取得されます。 役に立つドキュメントを持ったモデルは次のようなものです: class BlogEntry ( models . Model ): """ Stores ... ... eps. You can also use the "edit" option in rebase. This way you can change a single commit, for example to fix a typo in a docstring: git rebase -i HEAD~3 # Choose edit, pick, pick for the commits # Now you are able to rework the commit (use git add norma ... essage along the lines of: Made changes asked in review by <reviewer>. - Fixed whitespace errors in foobar. - Reworded the docstring of bar(). Finally, push your work back to your GitHub repository. Since you didn't touch the public commits during the reb ... ... eps. You can also use the "edit" option in rebase. This way you can change a single commit, for example to fix a typo in a docstring: git rebase -i HEAD~3 # Choose edit, pick, pick for the commits # Now you are able to rework the commit (use git add norma ... essage along the lines of: Made changes asked in review by <reviewer>. - Fixed whitespace errors in foobar. - Reworded the docstring of bar(). Finally, push your work back to your GitHub repository. Since you didn't touch the public commits during the reb ... ... ine lengths. We allow up to 88 characters in code, as this is the line length used by black . Documentation, comments, and docstrings should be wrapped at 79 characters. These limits are checked when flake8 is run. String variable interpolation may use %- ... oters() , not poll.getUniqueVoters() ). Use InitialCaps for class names (or for factory functions that return classes). In docstrings, follow the style of existing docstrings and PEP 257 . In tests, use assertRaisesMessage() and assertWarnsMessage() inste ... assertTrue() and assertFalse() , so you can check the actual boolean value, not the truthiness of the expression. In test docstrings, state the expected behavior that each test demonstrates. Don't include preambles such as "Tests that" or "Ensures that". ... ... ine lengths. We allow up to 88 characters in code, as this is the line length used by black . Documentation, comments, and docstrings should be wrapped at 79 characters. These limits are checked when flake8 is run. String variable interpolation may use %- ... oters() , not poll.getUniqueVoters() ). Use InitialCaps for class names (or for factory functions that return classes). In docstrings, follow the style of existing docstrings and PEP 257 . In tests, use assertRaisesMessage() and assertWarnsMessage() inste ... assertTrue() and assertFalse() , so you can check the actual boolean value, not the truthiness of the expression. In test docstrings, state the expected behavior that each test demonstrates. Don't include preambles such as "Tests that" or "Ensures that". ... ... gument for Signal is deprecated. If you rely on this argument as documentation, you can move the text to a code comment or docstring. Calling django.utils.crypto.get_random_string() without a length argument is deprecated. The list message for ModelMultip ... ... ドを追加できるようになりました。 URLField の値がリンクとしてレンダリングされるようになりました。 django.contrib.admindocs ¶ docstring 内のコンポーネントへのリンクは、 :role:`リンクテキスト <link>` という形式を用いることで、カスタムのリンクテキストをサポート ... ... gument for Signal is deprecated. If you rely on this argument as documentation, you can move the text to a code comment or docstring. Calling django.utils.crypto.get_random_string() without a length argument is deprecated. The list message for ModelMultip ... ... ドを追加できるようになりました。 URLField の値がリンクとしてレンダリングされるようになりました。 django.contrib.admindocs ¶ docstring 内のコンポーネントへのリンクは、 :role:`リンクテキスト <link>` という形式を用いることで、カスタムのリンクテキストをサポート ... 2026年10月08日