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.

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

Undocumented built-in exceptions #54932

Closed
flashk mannequin opened this issue Dec 17, 2010 · 5 comments
Closed

Undocumented built-in exceptions #54932

flashk mannequin opened this issue Dec 17, 2010 · 5 comments
Labels
docs Documentation in the Doc dir

Comments

@flashk
Copy link
Mannequin

flashk mannequin commented Dec 17, 2010

BPO 10723
Nosy @birkenfeld
Files
  • exceptions.diff
  • exceptions_2.diff
  • 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 2010-12-18.17:51:45.955>
    created_at = <Date 2010-12-17.00:07:21.322>
    labels = ['docs']
    title = 'Undocumented built-in exceptions'
    updated_at = <Date 2010-12-18.17:51:45.954>
    user = 'https://bugs.python.org/flashk'

    bugs.python.org fields:

    activity = <Date 2010-12-18.17:51:45.954>
    actor = 'georg.brandl'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2010-12-18.17:51:45.955>
    closer = 'georg.brandl'
    components = ['Documentation']
    creation = <Date 2010-12-17.00:07:21.322>
    creator = 'flashk'
    dependencies = []
    files = ['20085', '20099']
    hgrepos = []
    issue_num = 10723
    keywords = ['patch']
    message_count = 5.0
    messages = ['124165', '124168', '124214', '124250', '124300']
    nosy_count = 3.0
    nosy_names = ['georg.brandl', 'flashk', 'docs@python']
    pr_nums = []
    priority = 'normal'
    resolution = 'fixed'
    stage = 'patch review'
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue10723'
    versions = ['Python 3.1', 'Python 2.7', 'Python 3.2']

    @flashk
    Copy link
    Mannequin Author

    flashk mannequin commented Dec 17, 2010

    The "Built-in Exceptions" page of the Python 2.7 documentation is missing descriptions for BufferError, IndentationError, and TabError.

    I've gone ahead and added a brief description of each error to the page.

    @flashk flashk mannequin assigned docspython Dec 17, 2010
    @flashk flashk mannequin added the docs Documentation in the Doc dir label Dec 17, 2010
    @flashk
    Copy link
    Mannequin Author

    flashk mannequin commented Dec 17, 2010

    Just realized I previously attached the entire file. Here is the diff instead.

    @birkenfeld
    Copy link
    Member

    Basically fine, but the docs for indentation and tab error should document their inheritance more explicitly.

    @flashk
    Copy link
    Mannequin Author

    flashk mannequin commented Dec 17, 2010

    I just attached a new patch that explicitly mentions the inheritance of IndentationError and TabError.

    @birkenfeld
    Copy link
    Member

    Committed in r87378.

    @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
    Labels
    docs Documentation in the Doc dir
    Projects
    None yet
    Development

    No branches or pull requests

    1 participant