Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create "Source Code" links in module sections, where relevant #71491

Closed
yoniLavi mannequin opened this issue Jun 13, 2016 · 4 comments
Closed

Create "Source Code" links in module sections, where relevant #71491

yoniLavi mannequin opened this issue Jun 13, 2016 · 4 comments
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@yoniLavi
Copy link
Mannequin

yoniLavi mannequin commented Jun 13, 2016

BPO 27304
Nosy @terryjreedy, @yoniLavi
Files
  • mywork.patch
    		•

    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:

    assignee = None
closed_at = <Date 2016-06-23.02:55:14.153>
created_at = <Date 2016-06-13.04:14:43.109>
labels = ['type-feature', 'docs']
title = 'Create "Source Code" links in module sections, where relevant'
updated_at = <Date 2016-06-23.02:55:14.152>
user = 'https://github.com/yoniLavi'

    bugs.python.org fields:

    activity = <Date 2016-06-23.02:55:14.152>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = True
closed_date = <Date 2016-06-23.02:55:14.153>
closer = 'terry.reedy'
components = ['Documentation']
creation = <Date 2016-06-13.04:14:43.109>
creator = 'Yoni Lavi'
dependencies = []
files = ['43369']
hgrepos = []
issue_num = 27304
keywords = ['patch']
message_count = 4.0
messages = ['268417', '269095', '269100', '269101']
nosy_count = 4.0
nosy_names = ['terry.reedy', 'docs@python', 'python-dev', 'Yoni Lavi']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue27304'
versions = ['Python 3.5', 'Python 3.6']
    @yoniLavi
    Copy link
    Mannequin Author

    yoniLavi mannequin commented Jun 13, 2016

    This is a follow to bpo-22558.

    As per Terry's suggestion in bpo-22558, for packages with multiple modules that are all documented on the same page and that currently have a "Source Code" link to an __init__ file (e.g. importlib), we should also add more specific "Source Code" links to the module sections.

    Attached is a patch for the documentation of the 3 such packages that I found: importlib, dbm and json

    @yoniLavi yoniLavi mannequin assigned docspython Jun 13, 2016
    @yoniLavi yoniLavi mannequin added the docs Documentation in the Doc dir label Jun 13, 2016
    @terryjreedy
    Copy link
    Member

    Looks good at first review on Rietveld. Will test next.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jun 23, 2016

    New changeset e3b4033e0ea7 by Terry Jan Reedy in branch '3.5':
    Issue bpo-27304: Source code links for sub-packages in the same file.
    https://hg.python.org/cpython/rev/e3b4033e0ea7

    @terryjreedy
    Copy link
    Member

    Three of the links are to one- or two- line modules that import the C implementation. I considered dropping them, but decided that the only way to know that they are not worth looking at is to let someone take a look. A counter argument is that we don't have links to CPython C implementations, and we could pretend that the Python wrappers are not there. Another core developer who feels strongly enough can remove the three.

    Thanks for the nice patch. I hope you do some more.

    @terryjreedy terryjreedy added the type-feature A feature request or enhancement label Jun 23, 2016
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    1 participant
    @terryjreedy