Skip to content

Commit 3c9447a

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent 56aebe2 commit 3c9447a

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/development/docsguide.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ a table showing the latest notebook execution:
2828

2929
## Style guide
3030

31-
- **Prefer `import parcels` over `from parcels import class` in tutorials and how-to guides** so its obvious in later
32-
code cells which classes and methods are part of Parcels.
33-
- [**Avoid too much Repitition In Documentation**](https://www.writethedocs.org/guide/writing/docs-principles/#arid):
34-
tutorials and how-to guides notebooks will often have repetition of the general **Parcels** steps, (e.g., imports ) -
35-
this is needed so that users have complete examples that they can copy and experiment with.`. We try to limit each page
36-
in the documentation to a small number of examples.
37-
- Introduce links and cross-references to maximize discoverability of documentation. This also reduces the necessity for
38-
repetition in notebooks.
31+
- **Prefer `import parcels` over `from parcels import class` in tutorials and how-to guides** so its obvious in later
32+
code cells which classes and methods are part of Parcels.
33+
- [**Avoid too much Repitition In Documentation**](https://www.writethedocs.org/guide/writing/docs-principles/#arid):
34+
tutorials and how-to guides notebooks will often have repetition of the general **Parcels** steps, (e.g., imports ) -
35+
this is needed so that users have complete examples that they can copy and experiment with.`. We try to limit each page
36+
in the documentation to a small number of examples.
37+
- Introduce links and cross-references to maximize discoverability of documentation. This also reduces the necessity for
38+
repetition in notebooks.
3939
- **Import packages at the top of the section in which they are first used** to show what they are used for.
4040
- **Write documentation in first person plural ("we").** In our open source code, tutorials and guides can be written
4141
by any developer or user, so the documentation teaches all of us how to do something with Parcels. Sometimes it can be

0 commit comments

Comments
 (0)