Skip to content

Commit d714478

Browse files
authored
Various small writing fixes in the docs (#767)
1 parent 386477d commit d714478

File tree

10 files changed

+178
-156
lines changed

10 files changed

+178
-156
lines changed

.github/ISSUE_TEMPLATE/1-bug.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ assignees: ''
77
---
88

99
<!--
10-
Thank you very much for contributing! If you enjoy this project, please consider
11-
giving it a ⭐ star on [GitHub](https://github.com/omni-us/jsonargparse/) or
12-
sponsor it via [GitHub Sponsors](https://github.com/sponsors/mauvilsa). Even the
13-
smallest donation is greatly appreciated and helps support the project.
10+
Thank you for contributing! If you enjoy this project, please consider:
11+
- ⭐ Starring it on GitHub: https://github.com/omni-us/jsonargparse
12+
- 🩷 Sponsoring it: https://github.com/sponsors/mauvilsa
13+
14+
Even small donations are greatly appreciated and help sustain the project.
1415
-->
1516

1617
<!--

.github/ISSUE_TEMPLATE/2-regression.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ assignees: ''
77
---
88

99
<!--
10-
Thank you very much for contributing! If you enjoy this project, please consider
11-
giving it a ⭐ star on [GitHub](https://github.com/omni-us/jsonargparse/) or
12-
sponsor it via [GitHub Sponsors](https://github.com/sponsors/mauvilsa). Even the
13-
smallest donation is greatly appreciated and helps support the project.
10+
Thank you for contributing! If you enjoy this project, please consider:
11+
- ⭐ Starring it on GitHub: https://github.com/omni-us/jsonargparse
12+
- 🩷 Sponsoring it: https://github.com/sponsors/mauvilsa
13+
14+
Even small donations are greatly appreciated and help sustain the project.
1415
-->
1516

1617
## 🕰️ Regression report

.github/ISSUE_TEMPLATE/3-documentation.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ assignees: ''
77
---
88

99
<!--
10-
Thank you very much for contributing! If you enjoy this project, please consider
11-
giving it a ⭐ star on [GitHub](https://github.com/omni-us/jsonargparse/) or
12-
sponsor it via [GitHub Sponsors](https://github.com/sponsors/mauvilsa). Even the
13-
smallest donation is greatly appreciated and helps support the project.
10+
Thank you for contributing! If you enjoy this project, please consider:
11+
- ⭐ Starring it on GitHub: https://github.com/omni-us/jsonargparse
12+
- 🩷 Sponsoring it: https://github.com/sponsors/mauvilsa
13+
14+
Even small donations are greatly appreciated and help sustain the project.
1415
-->
1516

1617
<!--

.github/ISSUE_TEMPLATE/4-enhancement.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ assignees: ''
77
---
88

99
<!--
10-
Thank you very much for contributing! If you enjoy this project, please consider
11-
giving it a ⭐ star on [GitHub](https://github.com/omni-us/jsonargparse/) or
12-
sponsor it via [GitHub Sponsors](https://github.com/sponsors/mauvilsa). Even the
13-
smallest donation is greatly appreciated and helps support the project.
10+
Thank you for contributing! If you enjoy this project, please consider:
11+
- ⭐ Starring it on GitHub: https://github.com/omni-us/jsonargparse
12+
- 🩷 Sponsoring it: https://github.com/sponsors/mauvilsa
13+
14+
Even small donations are greatly appreciated and help sustain the project.
1415
-->
1516

1617
<!--

.github/ISSUE_TEMPLATE/5-refactor.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ assignees: ''
77
---
88

99
<!--
10-
Thank you very much for contributing! If you enjoy this project, please consider
11-
giving it a ⭐ star on [GitHub](https://github.com/omni-us/jsonargparse/) or
12-
sponsor it via [GitHub Sponsors](https://github.com/sponsors/mauvilsa). Even the
13-
smallest donation is greatly appreciated and helps support the project.
10+
Thank you for contributing! If you enjoy this project, please consider:
11+
- ⭐ Starring it on GitHub: https://github.com/omni-us/jsonargparse
12+
- 🩷 Sponsoring it: https://github.com/sponsors/mauvilsa
13+
14+
Even small donations are greatly appreciated and help sustain the project.
1415
-->
1516

1617
## 🔧 Code refactor

.github/ISSUE_TEMPLATE/6-other.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ assignees: ''
77
---
88

99
<!--
10-
Thank you very much for contributing! If you enjoy this project, please consider
11-
giving it a ⭐ star on [GitHub](https://github.com/omni-us/jsonargparse/) or
12-
sponsor it via [GitHub Sponsors](https://github.com/sponsors/mauvilsa). Even the
13-
smallest donation is greatly appreciated and helps support the project.
10+
Thank you for contributing! If you enjoy this project, please consider:
11+
- ⭐ Starring it on GitHub: https://github.com/omni-us/jsonargparse
12+
- 🩷 Sponsoring it: https://github.com/sponsors/mauvilsa
13+
14+
Even small donations are greatly appreciated and help sustain the project.
1415
-->
1516

1617
<!-- Here describe your issue. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
<!--
2-
Thank you very much for contributing! If you enjoy this project, please consider
3-
giving it a ⭐ star on [GitHub](https://github.com/omni-us/jsonargparse/) or
4-
sponsor it via [GitHub Sponsors](https://github.com/sponsors/mauvilsa). Even the
5-
smallest donation is greatly appreciated and helps support the project.
2+
Thank you for contributing! If you enjoy this project, please consider:
3+
- ⭐ Starring it on GitHub: https://github.com/omni-us/jsonargparse
4+
- 🩷 Sponsoring it: https://github.com/sponsors/mauvilsa
5+
6+
Even small donations are greatly appreciated and help sustain the project.
67
-->
78

89
<!--

CONTRIBUTING.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,7 @@ follows:
7171
``.pre-commit-config.yaml`` is configured to run the hooks using Python
7272
3.12. Ensure you have Python 3.12 installed and available in your
7373
environment for ``pre-commit`` to function correctly. For development, other
74-
Python versions will work, but for convenience, Python 3.12 can also be
75-
used.
74+
Python versions will work, but for convenience, Python 3.12 is recommended.
7675

7776
The ``pre-push`` stage runs several hooks, including tests, doctests, mypy, and
7877
coverage. These hooks are designed to inform developers of issues that must be

0 commit comments

Comments
 (0)