[issue10291] Clean-up turtledemo in-package documentation
Roundup Robot added the comment: New changeset 7708f80940b0 by Terry Jan Reedy in branch '3.4': Issue #10291: Backport 004fe3449193 with a few changes due to 22095. http://hg.python.org/cpython/rev/7708f80940b0 New changeset 68902ee48985 by Terry Jan Reedy in branch 'default': Issue #10291: null merge http://hg.python.org/cpython/rev/68902ee48985 -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Terry J. Reedy added the comment: Is there any reason when turtledemo.__init__ and turtledemo.__main__ should not get docstrings in earlier versions? And the turtledemo.__main__ get the same changes in 3.4? Not doing so introduced seeming gratuitous differences between the versions. The help refactoring I committed in 3.4 for #22053 could not be merged as it is. The demohelp.txt changes I have made for 3.4 have cleanly merged forward to file that is ignored and no longer displayed. With demohelp.txt moved to a docstring for 3.4 also, I would leave demohelp.txt in 3.4 but mark it 'unmaintained. Why was demohelp.txt left after being copied to .__main__? Expecting the file and docstring to remain in sync is not realistic. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Ned Deily added the comment: Is there any reason when turtledemo.__init__ and turtledemo.__main__ should not get docstrings in earlier versions? And the turtledemo.__main__ get the same changes in 3.4? I think my reasoning was that it was not a bug fix so it wasn't a strong candidate for a maintenance release. But feel free to backport it if you think it important. Why was demohelp.txt left after being copied to .__main__? It wasn't: 004fe3449193 deleted it. It appears that an incorrect merge from 3.4 (3f4abe3107ce) in a subsequent set of changes for Issue21823 brought it back to life in default. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Terry J. Reedy added the comment: Thanks for the explanation. I will re-delete the file after copying 3.4 version to docstring and marking the original .txt as frozen. I will do same with other files deleted in 3.5. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Jessica McKellar added the comment: Thanks for the bug report and patch, belopolsky! The original patch no longer applies cleanly, so attached is a regenerated version. * The new patch passes `make patchcheck`. * The full test suite passes with this patch. * I manually tested that before the patch, `./python.exe Lib/turtledemo/__main__.py` would start the demo window behind the Terminal on OSX, and after the patch it starts in front as desired. * I manually checked the 3 help menu drop-down options in the demo, and they have the expected content. There is a lot of out of date content in the turtle docs, and I think we should consider that work separate from this ticket and do a full audit of what needs updating in a new ticket. = commit review -- keywords: +needs review nosy: +jesstess stage: needs patch - commit review Added file: http://bugs.python.org/file34979/issue10291_2.diff ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Roundup Robot added the comment: New changeset 004fe3449193 by Ned Deily in branch 'default': Issue #10291: Cleanup turtledemo to use docstrings for help. http://hg.python.org/cpython/rev/004fe3449193 -- nosy: +python-dev ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Ned Deily added the comment: Thanks for the refresh, Jessica. I decided to separate out the turtle window raise for OS X and apply that for 3.4.1 and 3.5.0 in Issue11571. The remainder of the patch to use the docstrings, plus removal of the two other obsolete text files, is spplied here for 3.5.0. -- resolution: - fixed stage: commit review - resolved status: open - closed versions: +Python 3.5 -Python 3.3 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Éric Araujo mer...@netwok.org added the comment: Agreed. Which .py files would be appropriate? -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Alexander Belopolsky belopol...@users.sourceforge.net added the comment: On Tue, Mar 22, 2011 at 2:55 PM, Éric Araujo rep...@bugs.python.org wrote: .. Agreed. Which .py files would be appropriate? Lib/turtledemo/about_turtle.txt - seems to belong to turtle.py Lib/turtledemo/about_turtledemo.txt - turtledemo/__init__.py and Lib/turtledemo/demohelp.txt. - turtledemo/__main__.py or a new module to be imported from __main__ most of the code in __main__ can be moved/ -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Alexander Belopolsky belopol...@users.sourceforge.net added the comment: On Tue, Mar 22, 2011 at 3:14 PM, Alexander Belopolsky belopol...@users.sourceforge.net wrote: .. Lib/turtledemo/about_turtle.txt - seems to belong to turtle.py In fact, it looks like turtle docstring is already a copy (or almost a copy) of Lib/turtledemo/about_turtle.txt. Instead of reading about_turtle.txt, turtledemo should just reuse turtle.__doc__. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Changes by Alexander Belopolsky belopol...@users.sourceforge.net: -- type: - feature request versions: +Python 3.3 -Python 3.2 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Changes by Alexander Belopolsky belopol...@users.sourceforge.net: -- keywords: +patch Added file: http://bugs.python.org/file21340/issue10291.diff ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Éric Araujo mer...@netwok.org added the comment: The patch contains one unrelated code change. I think the docstrings should not go as is but be cleaned up to match docstrings conventions. I’ve also spotted some phrasing issues. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Alexander Belopolsky belopol...@users.sourceforge.net added the comment: On Tue, Mar 22, 2011 at 5:15 PM, Éric Araujo rep...@bugs.python.org wrote: .. The patch contains one unrelated code change. Yes, I noticed that, but it may not be that unrelated. Of course the two changes need to be committed separately, but the pop-under issue (issue11571) affects turtledemo in the same way as turtle. I think the docstrings should not go as is but be cleaned up to match docstrings conventions. I’ve also spotted some phrasing issues. I would rather keep code and documentation changes separate. Not that we have any strict docstrings conventions. :-) -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Éric Araujo mer...@netwok.org added the comment: I would rather keep code and documentation changes separate. I don’t follow; my comment about bad phrasing was about the text added to the docstrings. Not that we have any strict docstrings conventions. :-) Not enforced, but still useful to follow: PEP 257. *looks at ast.py and grumbles* -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
Alexander Belopolsky belopol...@users.sourceforge.net added the comment: On Tue, Mar 22, 2011 at 5:29 PM, Éric Araujo rep...@bugs.python.org wrote: .. I would rather keep code and documentation changes separate. I don’t follow; my comment about bad phrasing was about the text added to the docstrings. The text added to docstrings was copied from deleted text files. (I only fixed a few obvious anachronisms such as turtleDemo vs. turtledemo.) From user's POV, there is no change: the help topics display the same text as before. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue10291] Clean-up turtledemo in-package documentation
New submission from Alexander Belopolsky belopol...@users.sourceforge.net: Since after closing of issue #10199, docstrings in demo scripts are accessible to pydoc, it is important to bring them up to date. For example, turtledemo.wikipedia docstring contains a reference to nonexistent wikipedia1 and calls itself tdemo_wikipedia3.py. In addition, the turtledemo package contains three text files: Lib/turtledemo/about_turtle.txt, Lib/turtledemo/about_turtledemo.txt, and Lib/turtledemo/demohelp.txt. The contents of these files should be moved to appropriate (doc)strings inside appropriate .py files. -- assignee: belopolsky components: Demos and Tools, Documentation keywords: easy messages: 120200 nosy: belopolsky, eric.araujo, georg.brandl, glingl, gregorlingl, gvanrossum, ned.deily, r.david.murray, rhettinger, terry.reedy priority: normal severity: normal stage: needs patch status: open title: Clean-up turtledemo in-package documentation versions: Python 3.2 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10291 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
