Skip to content
This repository was archived by the owner on Aug 28, 2025. It is now read-only.

Commit f6735bc

Browse files
committed
Add backticks to inline code
Single backticks were used in places, which doesn't seem to render as code (at least on Firefox). Line 137 has a code statement within ** ** that isn't rendering correctly, but I'm not sure how to fix it.
1 parent 77ead1e commit f6735bc

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/writing/structure.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ compartmentalized**.
134134
Using ``from modu import func`` is a way to pinpoint the function you want to
135135
import and put it in the global namespace. While much less harmful than ``import
136136
*`` because it shows explicitly what is imported in the global namespace, its
137-
advantage over a simpler `import modu` is only that it will save some typing.
137+
advantage over a simpler ``import modu`` is only that it will save some typing.
138138

139139
**Very bad**
140140

@@ -181,8 +181,8 @@ different modules in the package are imported in a similar manner as plain
181181
modules, but with a special behavior for the :file:`__init__.py` file, which is used to
182182
gather all package-wide definitions.
183183

184-
A file :file:`modu.py` in the directory :file:`pack/` is imported with the statement `import
185-
pack.modu`. This statement will look for an :file:`__init__.py` file in :file:`pack`, execute
184+
A file :file:`modu.py` in the directory :file:`pack/` is imported with the statement ``import
185+
pack.modu``. This statement will look for an :file:`__init__.py` file in :file:`pack`, execute
186186
all of its top-level statements. Then it will look for a file :file:`pack/modu.py` and
187187
execute all of its top-level statements. After these operations, any variable,
188188
function, or class defined in :file:`modu.py` is available in the pack.modu namespace.
@@ -197,8 +197,8 @@ Leaving an :file:`__init__.py` file empty is considered normal and even a good p
197197
if the package's modules and sub-packages do not need to share any code.
198198

199199
Lastly, a convenient syntax is available for importing deeply nested packages:
200-
`import very.deep.module as mod`. This allows you to use `mod` in place of the verbose
201-
repetition of `very.deep.module`.
200+
``import very.deep.module as mod``. This allows you to use `mod` in place of the verbose
201+
repetition of ``very.deep.module``.
202202

203203
Object-oriented programming
204204
---------------------------

0 commit comments

Comments
 (0)