Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

style guide update#940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
daniel-demelo wants to merge3 commits intorealpython:master
base:master
Choose a base branch
Loading
fromdaniel-demelo:style-guide-update
Open
Changes from1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
PrevPrevious commit
quick fix
  • Loading branch information
@daniel-demelo
daniel-demelo committedNov 27, 2018
commit30a3504e4473d9fa059da68e3bde915fefdfa344
16 changes: 8 additions & 8 deletionsdocs/notes/styleguide.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,14 +30,14 @@ Strive to keep any contributions relevant to the :ref:`purpose of The Guide
<about-ref>`.

* Avoid including too much information on subjects that don't directly
relate to Python development.
relate to Python development.
* Prefer to link to other sources if the information is already out there.
Be sure to describe what and why you are linking.
Be sure to describe what and why you are linking.
* `Cite <http://sphinx.pocoo.org/rest.html?highlight=citations#citations>`_
references where needed.
references where needed.
* If a subject isn't directly relevant to Python, but useful in conjunction
with Python (e.g., Git, GitHub, Databases), reference by linking to useful
resources, and describe why it's useful to Python.
with Python (e.g., Git, GitHub, Databases), reference by linking to useful
resources, and describe why it's useful to Python.
* When in doubt, ask.


Expand All@@ -57,7 +57,7 @@ Blank lines
* One blank line before all other headings.
* One blank line after all headings.
* One blank line before and after a directive, *except for notes, no blank
lines after it*.
lines after it*.

.. code-block:: reStructuredText

Expand DownExpand Up@@ -178,14 +178,14 @@ Externally Linking
.. _Sphinx: http://sphinx.pocoo.org

* Prefer to use descriptive labels with inline links instead of leaving bare
links:
links:

.. code-block:: rest

Read the `Sphinx Tutorial <http://sphinx.pocoo.org/tutorial.html>`_

* Avoid using labels such as "click here", "this", etc. preferring
descriptive labels (SEO worthy) instead.
descriptive labels (SEO worthy) instead.


********************************
Expand Down

[8]ページ先頭

©2009-2025 Movatter.jp