python / cpython

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

devguide needs pictures #63807

Closed 9432cd65-9f88-4bc6-8ad6-72e5ab1c730d closed 10 years ago

9432cd65-9f88-4bc6-8ad6-72e5ab1c730d commented 10 years ago
BPO 19608
Nosy @ncoghlan, @ezio-melotti

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 = None closed_at = created_at = labels = ['type-feature', 'docs'] title = 'devguide needs pictures' updated_at = user = 'https://bugs.python.org/techtonik' ``` bugs.python.org fields: ```python activity = actor = 'ezio.melotti' assignee = 'none' closed = True closed_date = closer = 'ezio.melotti' components = ['Devguide'] creation = creator = 'techtonik' dependencies = [] files = [] hgrepos = [] issue_num = 19608 keywords = [] message_count = 6.0 messages = ['202933', '202935', '202950', '203014', '203105', '222384'] nosy_count = 4.0 nosy_names = ['ncoghlan', 'techtonik', 'ezio.melotti', 'BreamoreBoy'] pr_nums = [] priority = 'normal' resolution = 'works for me' stage = 'resolved' status = 'closed' superseder = None type = 'enhancement' url = 'https://bugs.python.org/issue19608' versions = [] ```

9432cd65-9f88-4bc6-8ad6-72e5ab1c730d commented 10 years ago

http://docs.python.org/devguide/

it covers pretty much complicated stuff, which takes a lot of time to grasp. Pictures help to save hours if not weeks. There needs to be some immediate intro picture at the top of front page illustrating transformation of Python code through the toolchain to machine execution instructions.

ncoghlan commented 10 years ago

Feel free to draw some and send a patch.

9432cd65-9f88-4bc6-8ad6-72e5ab1c730d commented 10 years ago

Thanks for the proposal, but you know perfectly that I am not a designer. I don't believe that there are no talented people who find this ticket interesting. You just need to add tag:easy to is (or allow others to do), so it became visible to these people via OpenHatch or through PSF outreach initiatives.

ncoghlan commented 10 years ago

We're not designers either. However, something that *could* help is to investigate whether or not the blockdiag and seqdiag Sphinx extensions can be integrated into the build toolchain for the devguide and the main Python docs.

That would drastically lower the barrier for including basic diagrams where appropriate (since it would just be ASCII art inside an appropriate Sphinx directive) and thus greatly increase the chance of it happening.

ezio-melotti commented 10 years ago

Plain ASCII-art might also be enough, but without specific indication of what kind of pictures you want and where you want them I'm going to close this.

83d2e70e-e599-4a04-b820-3814bbdb9bef commented 10 years ago

Please close this.