GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-107298: Fix references to undocumented APIs by vstinner · Pull Request #107304 · python/cpython

Conversation

@vstinner

@vstinner vstinner commented Jul 26, 2023 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member
  • Issue: Fix Sphinx warnings in the C API documentation #107298

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@vstinner
pythongh-107298: Fix references to undocumented APIs
ed05188
@bedevere-bot bedevere-bot mentioned this pull request Jul 26, 2023
Fix Sphinx warnings in the C API documentation #107298
Closed
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news labels Jul 26, 2023
@vstinner

vstinner commented Jul 26, 2023

Copy link
Copy Markdown
Member Author

@serhiy-storchaka: Ok, here is a more controversial change: fix references to undocumented APIs, but don't attempt to document them.

Sorry, I'm only motived to fix warnings, to make reviews more pleasant. I'm not motivated to write more documentation.

So what do you think? Is it ok do that? For now, I mark this change as a draft.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@serhiy-storchaka
serhiy-storchaka self-requested a review July 26, 2023 17:52
serhiy-storchaka
serhiy-storchaka reviewed Jul 26, 2023
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not sweep problems under the carpet. Warnings serve as reminders of lacks in the documentation.

If you want to filter out undocumented symbols from other issues, it is better to add them in the nitpick_ignore list. At least we will have a list of problems to solve in one place and can work on them one by one.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
CAM-Gerlach reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@vstinner

vstinner commented Jul 27, 2023

Copy link
Copy Markdown
Member Author

Ok, I will try to do that. I abandon this approach.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@vstinner vstinner closed this Jul 27, 2023
@vstinner
vstinner deleted the dox_fix_ref_undocumented branch July 27, 2023 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka left review comments
@ZeroIntensity ZeroIntensity Awaiting requested review from ZeroIntensity ZeroIntensity will be requested when the pull request is marked ready for review ZeroIntensity is a code owner

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@vstinner @serhiy-storchaka @bedevere-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.