python / cpython

The Python programming language
https://www.python.org/
Other
59.98k stars 29.03k forks source link

start docs for PyEval_* functions #36420

Closed theller closed 22 years ago

theller commented 22 years ago
BPO 543098
Nosy @freddrake, @theller
Files
  • ceval.tex: Prototypes marked up in LaTeX
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields: ```python assignee = 'https://github.com/theller' closed_at = created_at = labels = ['docs'] title = 'start docs for PyEval_* functions' updated_at = user = 'https://github.com/theller' ``` bugs.python.org fields: ```python activity = actor = 'theller' assignee = 'theller' closed = True closed_date = None closer = None components = ['Documentation'] creation = creator = 'theller' dependencies = [] files = ['4145'] hgrepos = [] issue_num = 543098 keywords = ['patch'] message_count = 4.0 messages = ['39551', '39552', '39553', '39554'] nosy_count = 2.0 nosy_names = ['fdrake', 'theller'] pr_nums = [] priority = 'normal' resolution = None stage = None status = 'closed' superseder = None type = None url = 'https://bugs.python.org/issue543098' versions = [] ```

    theller commented 22 years ago

    The start of a new (sub)section for the api manual. Should this go into api/utilities?

    theller commented 22 years ago

    Logged In: YES user_id=11105

    Typo in the summary.

    freddrake commented 22 years ago

    Logged In: YES user_id=3066

    The section needs a better heading. ;) (The Utilities chapter is fine; it can go at the end.) I'd also like to see more content in the section before it gets added (though that's just as easily fixed once the boilerplate is checked in). It would be good to review the material in "Documenting Python"; this is part of the standard documentation.

    PyEval_SetProfile() and PyEval_SetTrace() are already documented.

    Please continue with this!

    theller commented 22 years ago

    Logged In: YES user_id=11105

    The section needs a better heading. ;)

    This is where I need your help. These functions are in ceval.c, and I even don't know why. The reason would probably make a good header. Suggestions?

    Since I currently have no internet access except email and http, I will work on a local version.

    I'm also relying on you checking and fixing the markup ;-)