Description

sobolevn

opened on Oct 6, 2022

Issue body actions

Documentation

Right now our How-To Clinic guide does not mention that it is required to run python Tools/scripts/generate_global_objects.py command to generate global objects used by _Py_ID(), like in here:

    #define NUM_KEYWORDS 1
    static struct {
        PyGC_Head _this_is_not_used;
        PyObject_VAR_HEAD
        PyObject *ob_item[NUM_KEYWORDS];
    } _kwtuple = {
        .ob_base = PyVarObject_HEAD_INIT(&PyTuple_Type, NUM_KEYWORDS)
        .ob_item = { &_Py_ID(only_keys), },   // <--- Here!
    };
    #undef NUM_KEYWORDS

With this command the build fails.
I will send a PR to update docs today.

CC @larryhastings :)

Activity

1. sobolevn

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   on Oct 6, 2022
2. sobolevn

   self-assigned this

   on Oct 6, 2022
3. sobolevn

   added a commit that references this issue on Oct 6, 2022

   pythongh-97956: Mention `generate_global_objects.py` in `AC How-To`

   f130f74
4. larryhastings commented on Oct 6, 2022

   

   larryhastings

   on Oct 6, 2022

   Contributor

   More actions

   generate_global_objects.py is new, Argument Clinic is many years older. It sounds like the generate_global_objects.py authors should have added this documentation when they added this new feature.
5. ambv

   added a commit that references this issue on Oct 7, 2022

   gh-97956: Mention `generate_global_objects.py` in `AC How-To` (#97957)

   586cfb0
6. carljm

   added a commit that references this issue on Oct 8, 2022

   Merge branch 'main' into typewatch

   27a4980
7. mpage

   added a commit that references this issue on Oct 11, 2022

   pythongh-97956: Mention `generate_global_objects.py` in `AC How-To` (p…

   8bc17aa
8. sobolevn commented on Oct 12, 2022

   

   sobolevn

   on Oct 12, 2022

   MemberAuthor

   More actions

   Done! ✅
9. sobolevn

   closed this as completedon Oct 12, 2022
10. erlend-aasland

    added a commit that references this issue on Sep 8, 2023

    python/cpython#97956: Mention `generate_global_objects.py` in `AC How…

    5e68687
11. AA-Turner

    added a commit that references this issue on Sep 13, 2023

    python/cpython#97956: Mention `generate_global_objects.py` in `AC How…

    5f6ac54
12. erlend-aasland

    added a commit that references this issue on Sep 26, 2023

    python/cpython#97956: Mention `generate_global_objects.py` in `AC How…

    e630cce

Issue actions