gh-108826: Document `dis` module CLI and rename `_test` function to `main` #108827

chgnrdv · 2023-09-02T18:43:37Z

Fixes #108826.
dis module has CLI, but it is not documented and declared as 'test program' in source code. This patch mentions CLI in documentation and renames the function where it is implemented.

📚 Documentation preview 📚: https://cpython-previews--108827.org.readthedocs.build/

Issue: dis command line interface exists, but not documented #108826

dis module has CLI, but it is not documented and declared as 'test program' in source code. This patch mentions CLI in documentation and renames the function where it is implemented.

serhiy-storchaka

Is it the right place for that section? I used to see the "Command-line interface" section at the end of the file, only followed by examples and howtos. But there are documents which do not follow this "custom", so I no longer sure.

serhiy-storchaka · 2023-09-03T11:33:15Z

Misc/NEWS.d/next/Library/2023-09-02-18-48-44.gh-issue-108826.KG7abS.rst

@@ -0,0 +1 @@
+:mod:`dis` module command line interface is now mentioned in documentation.


I am not sure whether the Library section or the Documentation section are more suitable for this entry.

Different docs mention CLI in different sections of file. I was looking at trace and pdb docs when making these changes.
dis module has a preamble with brief introduction to its functionality, and I found the place below it suitable for CLI overview.

Yes, "Documentation" section seems more suitable for news entry, even if I made changes in library code. I'll submit a new one.

…G7abS.rst

hugovk

Thanks for this, a couple of little suggestions :)

Doc/library/dis.rst

Misc/NEWS.d/next/Documentation/2023-09-03-13-43-49.gh-issue-108826.KG7abS.rst

…8826.KG7abS.rst Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

hugovk · 2023-10-10T20:40:34Z

Please could you also update the anchor in https://docs.python.org/3.13/library/cmdline.html to link to the new CLI section of the dis page?

…cument-dis-cli

chgnrdv · 2023-10-10T21:43:12Z

#110249 added --show-caches command line option. I think it's OK if I will document it in this PR.

hugovk · 2023-10-10T22:30:40Z

Well spotted, thanks for adding it!

We'll have to make sure we don't include it in backports to 3.11 and 3.12. But we'll need a manual backport anyway, because we don't yet have Doc/library/cmdline.rst in those branches, and I also expect there will be some CLIs in 3.13 that don't belong in the other two.

miss-islington · 2023-10-11T05:54:02Z

Thanks @chgnrdv for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington · 2023-10-11T05:54:05Z

Sorry, @chgnrdv and @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 0d805b998ded854840f029b7f0c9a02eb3efa251 3.12

…n to `main` (python#108827) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> (cherry picked from commit 0d805b9)

bedevere-app · 2023-10-11T07:50:25Z

GH-110681 is a backport of this pull request to the 3.12 branch.

miss-islington · 2023-10-11T07:51:09Z

Thanks @chgnrdv for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington · 2023-10-11T07:51:10Z

Sorry, @chgnrdv and @hugovk, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 0d805b998ded854840f029b7f0c9a02eb3efa251 3.11

…n to `main` (python#108827) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> (cherry picked from commit 0d805b9)

bedevere-app · 2023-10-11T08:35:21Z

GH-110689 is a backport of this pull request to the 3.11 branch.

chgnrdv · 2023-10-11T11:43:38Z

@hugovk, thanks for review and backport!

hugovk · 2023-10-11T12:20:34Z

Thanks for the PR!

…on to `main` (#108827) (#110681) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: Radislav Chugunov <52372310+chgnrdv@users.noreply.github.com>

…on to `main` (#108827) (#110689) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: Radislav Chugunov <52372310+chgnrdv@users.noreply.github.com>

…n to `main` (python#108827) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>

Document dis module CLI, rename '_test' function to 'main'

4cc1070

dis module has CLI, but it is not documented and declared as 'test program' in source code. This patch mentions CLI in documentation and renames the function where it is implemented.

bedevere-bot added the awaiting review label Sep 2, 2023

chgnrdv changed the title ~~Document dis module CLI and rename '_test' function to 'main'~~ gh-108826: Document dis module CLI and rename '_test' function to 'main' Sep 2, 2023

bedevere-bot mentioned this pull request Sep 2, 2023

dis command line interface exists, but not documented #108826

Closed

chgnrdv changed the title ~~gh-108826: Document dis module CLI and rename '_test' function to 'main'~~ gh-108826: Document dis module CLI and rename _test function to main Sep 2, 2023

chgnrdv and others added 2 commits September 2, 2023 21:47

fix title underline

c7218ee

📜🤖 Added by blurb_it.

19ef422

This was referenced Sep 3, 2023

add program passed as string to dis module. #88571

Closed

bpo-44405: make dis cli "official" #26714

Closed

serhiy-storchaka reviewed Sep 3, 2023

View reviewed changes

serhiy-storchaka approved these changes Sep 3, 2023

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels Sep 3, 2023

chgnrdv and others added 2 commits September 3, 2023 16:42

Delete Misc/NEWS.d/next/Library/2023-09-02-18-48-44.gh-issue-108826.K…

74c9e74

…G7abS.rst

📜🤖 Added by blurb_it.

b77c813

hugovk reviewed Sep 3, 2023

View reviewed changes

Doc/library/dis.rst Outdated Show resolved Hide resolved

Misc/NEWS.d/next/Documentation/2023-09-03-13-43-49.gh-issue-108826.KG7abS.rst Outdated Show resolved Hide resolved

chgnrdv and others added 2 commits September 3, 2023 21:22

Update Misc/NEWS.d/next/Documentation/2023-09-03-13-43-49.gh-issue-10…

fca2c54

…8826.KG7abS.rst Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Update Doc/library/dis.rst

5d60cbe

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

hugovk approved these changes Sep 3, 2023

View reviewed changes

Merge branch 'main' into document-dis-cli

1fe24d9

chgnrdv and others added 5 commits October 10, 2023 23:43

Merge branch 'main' into document-dis-cli

5ad7976

link cmdline docs to dis docs CLI section

92da103

Merge branch 'document-dis-cli' of github.com:chgnrdv/cpython into do…

eaaf1cc

…cument-dis-cli

Merge branch 'main' into document-dis-cli

d476510

fix dis ref in cmdline docs

7b622f9

chgnrdv added 3 commits October 11, 2023 00:46

document --show-caches cmd option

9c4540d

Update dis.rst

544e908

Update dis.rst

489da89

hugovk merged commit 0d805b9 into python:main Oct 10, 2023

bedevere-app bot removed the awaiting merge label Oct 10, 2023

hugovk added the needs backport to 3.12 bug and security fixes label Oct 11, 2023

miss-islington assigned hugovk Oct 11, 2023

bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Oct 11, 2023

hugovk added the needs backport to 3.11 only security fixes label Oct 11, 2023

bedevere-app bot removed the needs backport to 3.11 only security fixes label Oct 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-108826: Document `dis` module CLI and rename `_test` function to `main` #108827

gh-108826: Document `dis` module CLI and rename `_test` function to `main` #108827

chgnrdv commented Sep 2, 2023 •

edited by bedevere-bot

Loading

serhiy-storchaka left a comment

serhiy-storchaka Sep 3, 2023

chgnrdv Sep 3, 2023 •

edited

Loading

hugovk left a comment

hugovk commented Oct 10, 2023

chgnrdv commented Oct 10, 2023

hugovk commented Oct 10, 2023

miss-islington commented Oct 11, 2023

miss-islington commented Oct 11, 2023

bedevere-app bot commented Oct 11, 2023

miss-islington commented Oct 11, 2023

miss-islington commented Oct 11, 2023

bedevere-app bot commented Oct 11, 2023

chgnrdv commented Oct 11, 2023

hugovk commented Oct 11, 2023

		@@ -0,0 +1 @@
		:mod:`dis` module command line interface is now mentioned in documentation.

gh-108826: Document dis module CLI and rename _test function to main #108827

gh-108826: Document dis module CLI and rename _test function to main #108827

Conversation

chgnrdv commented Sep 2, 2023 • edited by bedevere-bot Loading

serhiy-storchaka left a comment

Choose a reason for hiding this comment

serhiy-storchaka Sep 3, 2023

Choose a reason for hiding this comment

chgnrdv Sep 3, 2023 • edited Loading

Choose a reason for hiding this comment

hugovk left a comment

Choose a reason for hiding this comment

hugovk commented Oct 10, 2023

chgnrdv commented Oct 10, 2023

hugovk commented Oct 10, 2023

miss-islington commented Oct 11, 2023

miss-islington commented Oct 11, 2023

bedevere-app bot commented Oct 11, 2023

miss-islington commented Oct 11, 2023

miss-islington commented Oct 11, 2023

bedevere-app bot commented Oct 11, 2023

chgnrdv commented Oct 11, 2023

hugovk commented Oct 11, 2023

gh-108826: Document `dis` module CLI and rename `_test` function to `main` #108827

gh-108826: Document `dis` module CLI and rename `_test` function to `main` #108827

chgnrdv commented Sep 2, 2023 •

edited by bedevere-bot

Loading

chgnrdv Sep 3, 2023 •

edited

Loading