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

Touch up one-line descriptions of modules for module index #65262

Closed
brettcannon opened this issue Mar 25, 2014 · 8 comments
Closed

Touch up one-line descriptions of modules for module index #65262

brettcannon opened this issue Mar 25, 2014 · 8 comments
Labels
docs Documentation in the Doc dir easy

Comments

@brettcannon
Copy link
Member

BPO 21063
Nosy @brettcannon, @miss-islington
PRs
  • bpo-21063: Improve module synopsis #17363
  • [3.7] bpo-21063: Improve module synopsis for for various modules (GH-17363) #17381
  • [3.6] bpo-21063: Improve module synopsis for various modules (GH-17363) #17382
  • [3.8] bpo-21063: Improve module synopsis for various modules (GH-17363) #17383
    		•
    Files
  • this_module_doc_fix.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 2019-11-25.22:18:29.599>
created_at = <Date 2014-03-25.16:00:11.509>
labels = ['easy', 'docs']
title = 'Touch up one-line descriptions of modules for module index'
updated_at = <Date 2019-11-26.20:02:31.029>
user = 'https://github.com/brettcannon'

    bugs.python.org fields:

    activity = <Date 2019-11-26.20:02:31.029>
actor = 'brett.cannon'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-11-25.22:18:29.599>
closer = 'brett.cannon'
components = ['Documentation']
creation = <Date 2014-03-25.16:00:11.509>
creator = 'brett.cannon'
dependencies = []
files = ['34639']
hgrepos = []
issue_num = 21063
keywords = ['patch', 'easy']
message_count = 8.0
messages = ['214834', '214979', '214980', '214981', '214982', '357462', '357463', '357528']
nosy_count = 4.0
nosy_names = ['brett.cannon', 'docs@python', 'angad', 'miss-islington']
pr_nums = ['17363', '17381', '17382', '17383']
priority = 'low'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue21063'
versions = ['Python 3.5']
    @brettcannon
    Copy link
    Member Author

    E.g. linecache says "This module provides random access to individual lines from text files." That's a big awkward and could just drop "This module" to read more easily.

    @brettcannon brettcannon added docs Documentation in the Doc dir easy labels Mar 25, 2014
    @angad
    Copy link
    Mannequin

    angad mannequin commented Mar 27, 2014

    Interested in taking this up as my first patch -
    @brett - are you only talking about the :synopsis: or the occurrence of "This module" at the beginning of the description as well?
    -angad

    @brettcannon
    Copy link
    Member Author

    Just the synopsis lines for the modules.

    @angad
    Copy link
    Mannequin

    angad mannequin commented Mar 27, 2014

    Not a lot of occurrences if I only look at the synopsis. Attaching a diff.
    Also saw a weird "This subpackage" in apiref.rst line 1767. Fix that too?

    @brettcannon
    Copy link
    Member Author

    Sure, if you are just looking for "This module" you won't find very many instances. The bug is more about doing a sweep through *every* module's synopsis and just cleaning them up to read better. The "this module" instance for linecache is just an example of why a cleanup would be good to do.

    @brettcannon
    Copy link
    Member Author

    New changeset f8a6316 by Brett Cannon (Sanchit Khurana) in branch 'master':
    bpo-21063: Improve module synopsis for distutils (GH-17363)
    f8a6316

    @miss-islington
    Copy link
    Contributor

    New changeset 089387e by Miss Islington (bot) in branch '3.8':
    bpo-21063: Improve module synopsis for distutils (GH-17363)
    089387e

    @brettcannon
    Copy link
    Member Author

    New changeset 2f24893 by Brett Cannon (Miss Islington (bot)) in branch '3.7':
    bpo-21063: Improve module synopsis for distutils (GH-17363) (bpo-17381)
    2f24893

    @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 easy
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @brettcannon @miss-islington