Skip to content

Commit c6ceb6e

Browse files
Fix miscellaneous and consistency errors. (#140)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent 6d05d4f commit c6ceb6e

File tree

8 files changed

+15
-15
lines changed

8 files changed

+15
-15
lines changed

docs/monthly-meeting/2023-03.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
- **Calendar event:** (send your e-mail to Mariatta for an invitation)
99
- **How to participate:**
1010
- Go to [Google Meet](https://meet.google.com/dii-qrzf-wkw) and ask to be let in.
11-
- To edit notes, click the pencil" or “split view” button on the [HackMD document](https://hackmd.io/@encukou/pydocswg1). You need to log in (e.g. with a GitHub account).
11+
- To edit notes, click the "pencil" or “split view” button on the [HackMD document](https://hackmd.io/@encukou/pydocswg1). You need to log in (e.g. with a GitHub account).
1212

1313
By participating in this meeting, you are agreeing to abide by and uphold the [PSF Code of Conduct](https://www.python.org/psf/codeofconduct/).
1414
Please take a second to read through it!

docs/monthly-meeting/2023-05.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Congrats Ned for the [keynote at PyCon US 2023](https://us.pycon.org/2023/about/
6464
* Main benefit: multiple admins instead of single-person bottleneck with Netlify.
6565
* [python/cpython#103843](https://github.com/python/cpython/pull/103843)
6666
* GH action to update the link from the PR - we don't need one for Netlify
67-
* [JDLH thinks this means] GitHub action to update a link to a documentation preview on ReadTheDocs from the Github Pull Request page. We don't need such a preview for the current docs as published at Netlify.
67+
* [JDLH thinks this means] GitHub action to update a link to a documentation preview on ReadTheDocs from the GitHub Pull Request page. We don't need such a preview for the current docs as published at Netlify.
6868
* Example of preview link: Pull Request [#104013, **gh-104010: Separate and improve docs for typing.get_origin and typing.get_args**](https://github.com/python/cpython/pull/104013), contains a link to a preview of the documentation reflecting the Pull Request's effects, at [https://cpython-previews--104013.org.readthedocs.build/en/104013/](https://cpython-previews--104013.org.readthedocs.build/en/104013/).
6969
* For moving main docs, a few more things are needed, but they're tracked at the RtD side
7070
* We're using a personal account (Mariatta's). Not ideal. Right now community version of RtD doesn't support multiple owners, there are workarounds. Organizations are only in the commercial version so far.
@@ -102,7 +102,7 @@ Congrats Ned for the [keynote at PyCon US 2023](https://us.pycon.org/2023/about/
102102
- Manuel: started 3 years ago: have a place to connect with other translators and resources
103103
- Julien introduced the tools for translation.
104104
- Create channel for translations
105-
- Cristian: It also could be a good idea to have in the main Documentation page (that we will have soon) something like "Wanna help with a translation of these docs? check out this initiatives <list of languages here>"
105+
- Cristian: It also could be a good idea to have in the main Documentation page (that we will have soon) something like "Wanna help with a translation of these docs? check out these initiatives <list of languages here>"
106106
- Ezio: I already brought it up a couple of times, but it would be good to unify the translation infrastructure and tools (see e.g. [python/python-docs-zh-tw#399](https://github.com/python/python-docs-zh-tw/issues/399))
107107

108108

docs/monthly-meeting/2023-09.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Please take a second to read through it!
9090

9191
- [CAM] Quick update on reStructured Data
9292
- Summary
93-
- Mechanism to extract, process and output structured, machine-readible data from the Python docs
93+
- Mechanism to extract, process and output structured, machine-readable data from the Python docs
9494
- Initial focus on deprecations/removals per user requests, then additions/changes and finally other annotations (supported platforms, stable ABI, audit events, etc.)
9595
- Output a JSON per version and language for tool and API consumption
9696
- Also output tables of all/specific deprecations/removals (or other changes) in the What's New and on a new dedicated Deprecations/Removals page.

docs/monthly-meeting/2024-02.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Please take a second to read through it!
5454

5555
[Ezio] We should also figure out what to do about collapsible sections.
5656
[Ned] What problem are collapsible sections solving? Do we have too many examples that users will want to ignore? (In my docs I use tabs, but not collapsible sections)
57-
[Ezio] They allow us to to add more examples inline without making the page too long and more difficult to navigate, but they don't work with non-HTML builders.
57+
[Ezio] They allow us to add more examples inline without making the page too long and more difficult to navigate, but they don't work with non-HTML builders.
5858

5959
[Ned] re. pages being too long, we might switch to having a page for each function
6060
[Carol] we could run a cron job to count lines

docs/monthly-meeting/2024-08.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Please take a second to read through it!
3838
- In the last 1-2 months, we've been working on the language and version selector. In the current process this is added at build time from a JSON file, RTD does that at serve time with Javascript so even old versions of the docs link to current versions.
3939
- We've been working to not losing what we already have but also not get rid of RTD features.
4040
- 3.13 or 3.14 is the version we'll migrate first, to get a feel for the workflow. All other versions will be served by python.org for now. Then we'll migrate one version at a time.
41-
- [Trey] Will this enhance the search? [Manuel] There have been many improvements in RTD search lately. Traditionally RTD overwrites Sphinx search entirely with server-side (Elastic Search) search. Now there's a way to choose RTD or Sphinx search from the docs theme. There's also a person who said they're working on the Sphinx sphinx search engine.
41+
- [Trey] Will this enhance the search? [Manuel] There have been many improvements in RTD search lately. Traditionally RTD overwrites Sphinx search entirely with server-side (Elastic Search) search. Now there's a way to choose RTD or Sphinx search from the docs theme. There's also a person who said they're working on the Sphinx search engine.
4242
- [Trey] So there won't be a change on day one.
4343
- [Carol] For the PR previews, is there an option to link to the most changed file in the PR? [Manuel] We're working on it, don't know the details. The idea is to perform a diff and determine what changed, and link to it directly.
4444
- Issue: [readthedocs/readthedocs.org#11319](https://github.com/readthedocs/readthedocs.org/issues/11319)

docs/monthly-meeting/2024-09.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,18 @@ Please take a second to read through it!
1818

1919
(Name / `@GitHubUsername` *[/ Discord, if different]*)
2020

21-
- Daniele Procida / @EvilDMP
22-
- Hugo van Kemenade / @hugovk
23-
- Trey / @treyhunner
21+
- Daniele Procida / `@EvilDMP`
22+
- Hugo van Kemenade / `@hugovk`
23+
- Trey / `@treyhunner`
2424
- Manuel / `@humitos`
25-
- Melissa / @melissawm
26-
- Petr Viktorin / @encukou
25+
- Melissa / `@melissawm`
26+
- Petr Viktorin / `@encukou`
2727
- Ryan / `@ryan-duve`
2828

2929
## Discussion
3030

3131
- [Hugo]
32-
- As a RM, logged into the docs server, and fixed a bunch of stopped jobs
32+
- As an RM, logged into the docs server, and fixed a bunch of stopped jobs
3333
- It would be nice to have 2 cron jobs -- one for HTML (fast), one for PDFs (slow)
3434
- We have a bus factor for the repo; only 2 active people; we should give access to more people & we should give Adam access to the build server
3535
- Separately, we want to move HTML to Read the Docs, while keeping the ability to build them separately

docs/monthly-meeting/2024-10.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ to read through it!
134134
<https://en.wikipedia.org/wiki/Learning_pathway> -- people can start where they
135135
need, depending on how much handholding they need etc.
136136
- [Mariatta] Maybe the first quiz should be “what kind of a learner are you”?
137-
- [Carol] Moving away from the tooling: I thing there's a subset of users that use
137+
- [Carol] Moving away from the tooling: I think there's a subset of users that use
138138
the current Python tutorial, others use different ones - Carpentries, ones from
139139
the scientific ecosystem, Dr.Chuck, Chicago[???], etc. The Carpentries have done a
140140
great job in the past decade coming up with learning-theory-based tutorials:

docs/monthly-meeting/2024-11.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ to read through it!
2323

2424
(Name / `@GitHubUsername` _[/ Discord, if different]_)
2525

26-
- Hugo van Kemenade / @hugovk
26+
- Hugo van Kemenade / `@hugovk`
2727
- Mariatta
2828
- Joe
2929
- Ned Batchelder / `@nedbat`
3030
- Trey
3131
- Daniele
32-
- Ryan / `ryan-duve`
32+
- Ryan / `@ryan-duve`
3333
- Petr / `@encukou`
3434

3535
## Introductions

0 commit comments

Comments
 (0)