Skip to content

Docs: Add missing markup to Argument Clinic docs #106876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erlend-aasland merged 22 commits into from
Jul 24, 2023
Merged

Docs: Add missing markup to Argument Clinic docs #106876

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
e8068e0
Docs: Add missing markup to Argument Clinic docs
erlend-aasland Jul 18, 2023
cf66105
Add missing colon
erlend-aasland Jul 18, 2023
cd940e2
Pull in main
erlend-aasland Jul 19, 2023
6e5c44f
Address reviews
erlend-aasland Jul 19, 2023
d1627ae
Pull in main
erlend-aasland Jul 19, 2023
8f23956
Use :data: for METH_O and METH_NOARGS
erlend-aasland Jul 19, 2023
b155e38
For now, disable the METH_METHOD link
erlend-aasland Jul 19, 2023
971c058
Suggest 'make clinic' and 'make regen-global-objects' iso. running cl…
erlend-aasland Jul 19, 2023
bc33f97
Markup file suffixes and file paths with :file:
erlend-aasland Jul 19, 2023
f5bb4a3
Address review: rewrite line 919 similar to suggestion by Serhiy
erlend-aasland Jul 19, 2023
f892322
fixup! Suggest 'make clinic' and 'make regen-global-objects' iso. run…
erlend-aasland Jul 19, 2023
d96fdeb
Address review: markup more params with **
erlend-aasland Jul 19, 2023
f593853
Pull in main
erlend-aasland Jul 20, 2023
47061df
Address review: revert :program: markups
erlend-aasland Jul 20, 2023
ec6fc6c
Pull in main
erlend-aasland Jul 21, 2023
fe52717
Address review: fix 'int' markup around line 1330
erlend-aasland Jul 21, 2023
1a30f3b
Address review: use new and correct directives for C constants/macros
erlend-aasland Jul 21, 2023
8c69e70
Pull in main
erlend-aasland Jul 22, 2023
499ed66
Revert module.class markup
erlend-aasland Jul 22, 2023
d2f968a
Revert 'make clinic' changes
erlend-aasland Jul 22, 2023
eaaeb42
Pull in main
erlend-aasland Jul 24, 2023
8454b78
METH_METHOD now has its own anchor
erlend-aasland Jul 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Suggest 'make clinic' and 'make regen-global-objects' iso. running cl… 
…inic directly
  • Loading branch information
@erlend-aasland
erlend-aasland committed Jul 19, 2023
commit 971c0584fcb7da8809bd0da854963bdf4f5befcd
2 changes: 1 addition & 1 deletion Doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ SPHINXERRORHANDLING = -W
PAPEROPT_a4 = -D latex_elements.papersize=a4paper
PAPEROPT_letter = -D latex_elements.papersize=letterpaper

ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees $(PAPEROPT_$(PAPER)) -j $(JOBS) \
ALLSPHINXOPTS = -b $(BUILDER) -W -d build/doctrees $(PAPEROPT_$(PAPER)) -j $(JOBS) \
$(SPHINXOPTS) $(SPHINXERRORHANDLING) . build/$(BUILDER) $(SOURCES)

.PHONY: help
Expand Down
11 changes: 6 additions & 5 deletions Doc/howto/clinic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,8 +394,9 @@ Let's dive in!
Write a pickled representation of obj to the open file.
[clinic start generated code]*/

12. Save and close the file, then run :program:`Tools/clinic/clinic.py` on
it. With luck everything worked---your block now has output, and
12. Save and close the file, then run :program:`make clinic`
to regenerate the Argument Clinic code.
With luck everything worked---your block now has output, and
a ``.c.h`` file has been generated! Reopen the file in your
text editor to see::

Expand Down Expand Up @@ -459,7 +460,7 @@ Let's dive in!

If any of these items differ in *any way*,
adjust your Argument Clinic function specification and rerun
:program:`Tools/clinic/clinic.py` until they *are* the same.
:program:`make clinic` until they *are* the same.


14. Notice that the last line of its output is the declaration
Expand Down Expand Up @@ -548,7 +549,7 @@ Let's dive in!

&_Py_ID(new_unique_py_id)

If it does, you'll have to run :program:`Tools/scripts/generate_global_objects.py`
If it does, you'll have to run :program:`make regen-global-objects`
to regenerate the list of precompiled identifiers at this point.


Expand Down Expand Up @@ -1102,7 +1103,7 @@ For all of these, return ``-1`` to indicate error.

To see all the return converters Argument Clinic supports, along with
their parameters (if any),
just run :program:`Tools/clinic/clinic.py --converters` for the full list.
just run :program:`./Tools/clinic/clinic.py --converters` for the full list.


How to clone existing functions
Expand Down