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 — [3.8] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (GH-16607) by zware · Pull Request #19727 · python/cpython

Conversation

@zware

@zware zware commented Apr 27, 2020 •
edited by bedevere-bot
Loading

Uh oh!

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

Copy link
Copy Markdown
Member

Adds a short description of PyDoc_STRVAR and PyDoc_STR to "Useful macros" section of C-API docs.

Currently, there is one lone mention in the C-API reference, despite the fact that PyDoc_STRVAR is ubiquitous to Modules/.

Additionally, this properly uses c:macro within Doc/c-api/module.rst to link.
(cherry picked from commit b54e46c)

Authored-by: Brad Solomon [email protected]

https://bugs.python.org/issue38387

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bsolomon1124 @zware
[3.8] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (p…
572dace 
…ythonGH-16607)

Adds a short description of `PyDoc_STRVAR` and `PyDoc_STR` to "Useful macros" section of C-API docs.

Currently, there is [one lone mention](https://docs.python.org/3/c-api/module.html?highlight=pydoc_strvarGH-c.PyModuleDef) in the C-API reference, despite the fact that `PyDoc_STRVAR` is ubiquitous to `Modules/`.

Additionally, this properly uses `c:macro` within `Doc/c-api/module.rst` to link.
(cherry picked from commit b54e46c)

Co-authored-by: Brad Solomon <[email protected]>
@the-knights-who-say-ni the-knights-who-say-ni added the CLA signed label Apr 27, 2020
@bedevere-bot bedevere-bot mentioned this pull request Apr 27, 2020
bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros #16607
Merged
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting core review labels Apr 27, 2020
@zware
zware merged commit ca5649c into python:3.8 Apr 27, 2020
@zware
zware deleted the backport-b54e46c-3.8 branch April 27, 2020 02:45
@bedevere-bot bedevere-bot removed the awaiting core review label Apr 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

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

Assignees

No one assigned

Labels

docs Documentation in the Doc dir

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.

4 participants

@zware @the-knights-who-say-ni @bedevere-bot @bsolomon1124
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.