Roundup Robot added the comment:
New changeset dcb9ec098781 by Ezio Melotti in branch 'default':
#18021: remove broken link to the Apple Style Guide. Patch by Madison May.
http://hg.python.org/devguide/rev/dcb9ec098781
--
nosy: +python-dev
___
Ezio Melotti added the comment:
Since this was keep getting reported (see e.g. #18446) I now removed the link.
If you think an updated link to the Apple Style Guide should be included
instead please reopen, but from a quick look at it it's hard to tell what parts
are relevant to our docs.
Madison May added the comment:
If the general consensus is that the APSG link should be removed, here's one
more patch for you.
--
Added file: http://bugs.python.org/file30775/apsg_removed.patch
___
Python tracker rep...@bugs.python.org
Madison May added the comment:
So I've done a quick comparison of the two, and for the most part each entry is
an identical copy of the 2009 version. Some dated entries have been removed,
which I would consider a plus -- who realistically needs to know how to refer
to a 56K modems these day,
Ned Deily added the comment:
Documenting Python references to the Apple Style Guide go back to at least
Python 2.3.5's documentation, at that time to the 2001 version of the Apple
Style Guide. I was more curious if the Apple Style Guide was still being
actively consulted by the documentation
Ezio Melotti added the comment:
I don't think I ever read/consulted that page, except maybe the first time I
came across that link. I consult
http://docs.python.org/devguide/documenting.html regularly, but that is mostly
for the rst markup. Usually I just try to be consistent with the
Changes by Brett Cannon br...@python.org:
--
stage: - patch review
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18021
___
___
Python-bugs-list
Changes by Brett Cannon br...@python.org:
--
stage: patch review - needs patch
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18021
___
___
Madison May added the comment:
The attached patch updates the urls on the Documenting and Doc Quality pages to
reference the new Apple Style Guide.
--
keywords: +patch
Added file: http://bugs.python.org/file30456/apple_style_guide.patch
___
Python
Dmi Baranov added the comment:
That link will be outdated in next few months (I believe :-)). What about
https://help.apple.com/asg/mac ?
--
nosy: +dmi.baranov
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18021
Terry J. Reedy added the comment:
The latter link redirects to the current online searchable html version,
http://help.apple.com/asg/mac/2013/
and presumably always will. I think this is better than the 200 page pdf.
--
nosy: +terry.reedy
stage: needs patch - patch review
Madison May added the comment:
Updated patch to link instead to http://help.apple.com/asg/mac.
Thanks for that catch, Dmi and Terry. I have to agree that its a much better
alternative.
--
Added file: http://bugs.python.org/file30457/apple_style_guide_v2.patch
Ned Deily added the comment:
Has anyone looked at the current Apple style guide to determine whether it is
still an appropriate reference for Python doc usage? It appears to have
undergone some major changes over the years as Apple's docs have changed.
--
nosy: +ned.deily
Madison May added the comment:
I actually had a bit of a hard time even locating a copy of the 2009 version.
Thanks to the Wayback Machine, here's the 2009 version of the pdf for
reference:
New submission from Madison May:
The links at http://docs.python.org/devguide/documenting.html#building-doc and
http://docs.python.org/devguide/docquality.html to
http://developer.apple.com/mac/library/documentation/UserExperience/Conceptual/APStyleGuide/APSG_2009.pdf
lead to a Page Not Found
Changes by Madison May madison@students.olin.edu:
--
type: enhancement - behavior
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18021
___
___
16 matches
Mail list logo
