Sitelet https://github.com/python/cpython/pull/97964
Skip to content

gh-97669: Move difflib examples to Doc/includes/ - #97964

Merged
ambv merged 1 commit into
python:mainfrom
vstinner:difflib_examples
Oct 7, 2022
Merged

ambv merged 1 commit into
python:mainfrom
vstinner:difflib_examples

Conversation

@vstinner

@vstinner vstinner commented Oct 6, 2022 •

Copy link
Copy Markdown
Member

Remove diff.py and ndiff.py scripts of Tools/scripts/: move them to Doc/includes/.

  • diff.py and ndiff.py files are no longer executable. Remove also their shebang ("#!/usr/bin/env python3").
  • Remove the -profile command from ndiff.py to simply the code.
  • Remove ndiff.py copyright and history command. The Python documentation examples are distributed under the "Zero Clause BSD License".

@vstinner

vstinner commented Oct 6, 2022

Copy link
Copy Markdown
Member Author

I'm not sure if it's worth it to keep the ndiff.py example. Maybe we can just remove it? IMO ndiff.py is a little bit complicated to show it as an example.

@JulienPalard: Would you mind to have a look? Who else should I ask for a doc review?

@JulienPalard

Copy link
Copy Markdown
Member

@vstinner Those issues has been fixed (both sphinx-lint side for the false positives, and cpython side for the true positives), can you rebase?

Remove diff.py and ndiff.py scripts of Tools/scripts/: move them to
Doc/includes/.

* diff.py and ndiff.py files are no longer executable. Remove also
  their shebang ("#!/usr/bin/env python3").
* Remove the -profile command from ndiff.py to simply the code.
* Remove ndiff.py copyright and history command. The Python
  documentation examples are distributed under the "Zero Clause BSD
  License".
@vstinner

vstinner commented Oct 7, 2022

Copy link
Copy Markdown
Member Author

I rebased my PR.

I will not add a dedicated NEWS entry, since I already documented the removal in a previous PR: https://docs.python.org/dev/whatsnew/3.12.html#demos-and-tools

@ambv
ambv merged commit 002252c into python:main Oct 7, 2022
@vstinner
vstinner deleted the difflib_examples branch October 8, 2022 09:47
mpage pushed a commit to mpage/cpython that referenced this pull request Oct 11, 2022
Remove diff.py and ndiff.py scripts of Tools/scripts/: move them to
Doc/includes/.

* diff.py and ndiff.py files are no longer executable. Remove also
  their shebang ("#!/usr/bin/env python3").
* Remove the -profile command from ndiff.py to simply the code.
* Remove ndiff.py copyright and history command. The Python
  documentation examples are distributed under the "Zero Clause BSD
  License".
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants