8000 docs: Minor grammar improvements · diviyank/python@32be783 · GitHub
[go: up one dir, main page]
Skip to content

Commit 32be783

Browse files
ssbarneassbarnea
authored
docs: Minor grammar improvements
1 parent 3cbe472 commit 32be783

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Our Pledge
44

55
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
6+
contributors and maintainers pledge to make participation in our project and
77
our community a harassment-free experience for everyone, regardless of age, body
88
size, disability, ethnicity, gender identity and expression, level of experience,
99
nationality, personal appearance, race, religion, or sexual identity and
@@ -39,7 +39,7 @@ response to any instances of unacceptable behavior.
3939

4040
Project maintainers have the right and responsibility to remove, edit, or
4141
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned to this Code of Conduct, or to ban temporarily or
42+
that are not aligned with this Code of Conduct, or to ban temporarily or
4343
permanently any contributor for other behaviors that they deem inappropriate,
4444
threatening, offensive, or harmful.
4545

@@ -58,7 +58,7 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be
5858
reported by contacting the project team at pawamoy@pm.me. All
5959
complaints will be reviewed and investigated and will result in a response that
6060
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
61+
obligated to maintain confidentiality concerning the reporter of an incident.
6262
Further details of specific enforcement policies may be posted separately.
6363

6464
Project maintainers who do not follow or enforce the Code of Conduct in good

‎CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Scope and body are optional. Type can be:
9393
- `feat`: New feature.
9494
- `fix`: Bug fix.
9595
- `perf`: About performance.
96-
- `refactor`: Changes which are not features nor bug fixes.
96+
- `refactor`: Changes that are not features or bug fixes.
9797
- `style`: A change in code style/format.
9898
- `tests`: About tests.
9999

@@ -111,7 +111,7 @@ Fixes #15.
111111

112112
Link to any related issue in the Pull Request message.
113113

114-
During review, we recommend using fixups:
114+
During the review, we recommend using fixups:
115115

116116
```bash
117117
# SHA is the SHA of the commit you want to fix

‎README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ dependencies = [
3737
]
3838
```
3939

40-
You can also explicitely depend on the handler:
40+
You can also explicitly depend on the handler:
4141

4242
```toml title="pyproject.toml"
4343
# PEP 621 dependencies declaration
@@ -59,11 +59,11 @@ dependencies = [
5959
[Griffe](https://github.com/mkdocstrings/griffe).
6060

6161
- **Support for type annotations:** Griffe collects your type annotations and *mkdocstrings* uses them
62-
to display parameters types or return types. It is even able to automatically add cross-references
63-
to other objects from your API, from the standard library or from third-party libraries!
62+
to display parameter types or return types. It is even able to automatically add cross-references
63+
to other objects from your API, from the standard library or third-party libraries!
6464
See [how to load inventories](https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories) to enable it.
6565

66-
- **Recursive documentation of Python objects:** just use the module dotted-path as identifier, and you get the full
66+
- **Recursive documentation of Python objects:** just use the module dotted-path as an identifier, and you get the full
6767
module docs. You don't need to inject documentation for each class, function, etc.
6868

6969
- **Support for documented attributes:** attributes (variables) followed by a docstring (triple-quoted string) will
@@ -77,7 +77,7 @@ dependencies = [
7777
*We do not support nested admonitions in docstrings!*
7878

7979
- **Every object has a TOC entry:** we render a heading for each object, meaning *MkDocs* picks them into the Table
80-
of Contents, which is nicely display by the Material theme. Thanks to *mkdocstrings* cross-reference ability,
80+
of Contents, which is nicely displayed by the Material theme. Thanks to *mkdocstrings* cross-reference ability,
8181
you can reference other objects within your docstrings, with the classic Markdown syntax:
8282
`[this object][package.module.object]` or directly with `[package.module.object][]`
8383

‎docs/customization.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ See them [in the repository](https://github.com/mkdocstrings/python/tree/master/
124124
See the general *mkdocstrings* documentation to learn how to override them: https://mkdocstrings.github.io/theming/#templates.
125125

126126
In preparation for Jinja2 blocks, which will improve customization,
127-
each one of these templates extends in fact a base version in `theme/_base`. Example:
127+
each one of these templates extends a base version in `theme/_base`. Example:
128128

129129
```html+jinja title="theme/docstring/admonition.html"
130130
{% extends "_base/docstring/admonition.html" %}
@@ -139,7 +139,7 @@ each one of these templates extends in fact a base version in `theme/_base`. Exa
139139
```
140140

141141
It means you will be able to customize only *parts* of a template
142-
without having to fully copy-paste it in your project:
142+
without having to fully copy-paste it into your project:
143143

144144
```jinja title="templates/theme/docstring.html"
145145
{% extends "_base/docstring.html" %}

‎docs/usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ plugins:
7474
do_something: false
7575
```
7676

77-
These options affect how the documentation is collected from sources and renderered:
77+
These options affect how the documentation is collected from sources and rendered:
7878
headings, members, docstrings, etc.
7979

8080
::: mkdocstrings_handlers.python.handler.PythonHandler.default_config
@@ -202,7 +202,7 @@ TIP: **This is the recommended method.**
202202
```
203203

204204
Except for case 1, which is supported by default, **we strongly recommend
205-
to set the path to your packages using this option, even if it works without it**
205+
setting the path to your packages using this option, even if it works without it**
206206
(for example because your project manager automatically adds `src` to PYTHONPATH),
207207
to make sure anyone can build your docs from any location on their filesystem.
208208

@@ -211,7 +211,7 @@ to make sure anyone can build your docs from any location on their filesystem.
211211
WARNING: **This method has limitations.**
212212
This method might work for you, with your current setup,
213213
but not for others trying your build your docs with their own setup/environment.
214-
We recommend to use the [`paths` method](#using-the-paths-option) instead.
214+
We recommend using the [`paths` method](#using-the-paths-option) instead.
215215

216216
You can take advantage of the usual Python loading mechanisms.
217217
In Bash and other shells, you can run your command like this
@@ -270,7 +270,7 @@ In Bash and other shells, you can run your command like this
270270
WARNING: **This method has limitations.**
271271
This method might work for you, with your current setup,
272272
but not for others trying your build your docs with their own setup/environment.
273-
We recommend to use the [`paths` method](#using-the-paths-option) instead.
273+
We recommend using the [`paths` method](#using-the-paths-option) instead.
274274

275275
Install your package in the current environment, and run MkDocs:
276276

0 commit comments

Comments
 (0)
0