dev task of documenting undocumented APIs #10

Activity

1. Mariatta commented on Dec 9, 2016

   

   Mariatta

   on Dec 9, 2016

   Member

   More actions

   Just so we don't have to go to the bugtracker to remind ourselves of what this is about, here's a recap:

   Once the docs are built using Python 3, then the coverage results can be used by people wanting to contribute as something to do. Should also mention in the task that some APIs should probably be private: http://mail.python.org/pipermail/python-dev/2010-November/105476.html

   The issue is still valid and waiting for someone to submit a patch to the devguide.

   • provide developers guidance on how to document undocumented APIs
   • when and how to use __all__
   • include rules from the linked email
   • highlight "do no harm" to existing users as discussed in email

   👍React with 👍1Reacted by Carol Willing
2. willingc

   added

   type-featureAdditions; New content or section neededAdditions; New content or section needed

   on Mar 19, 2018
3. willingc commented on Oct 10, 2023

   

   willingc

   on Oct 10, 2023

   Collaborator

   More actions

   I'm going to go ahead and close this issue. Please reopen if you wish.
4. willingc

   closed this as completedon Oct 10, 2023
5. erlend-aasland commented on Oct 10, 2023

   

   erlend-aasland

   on Oct 10, 2023

   Contributor

   More actions

   Was this closed because it was resolved, or closed because it is not needed anymore?
6. encukou commented on Oct 18, 2023

   

   encukou

   on Oct 18, 2023

   Member

   More actions

   Michael's mail has been superseded by PEP-387.

   As for documenting undocumented APIs, AFAIK we could use the same process as for recent “linting”-style tasks. Here's a draft of concrete next steps:

   • Make the docs coverage build work
   • Add a list of current undocumented API, and make CI warn/fail if it finds undocumented API that's not in the list
   • Work to document API or mark known false positives

   Do I understand the issue correctly? If so it should probably go back to the cpython repo.
7. encukou

   reopened this on Oct 18, 2023