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

Jump to bottom

The parameter name for imghdr.what in the documentation is wrong #85455

Closed
aeltawela mannequin opened this issue Jul 12, 2020 · 2 comments
Closed

The parameter name for imghdr.what in the documentation is wrong #85455

aeltawela mannequin opened this issue Jul 12, 2020 · 2 comments
Labels
3.8 docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@aeltawela
Copy link
Mannequin

aeltawela mannequin commented Jul 12, 2020

BPO 41283
Nosy @ammaraskar, @nanjekyejoannah, @aeltawela
PRs
  • bpo-41283: Fix mismatched argument name for imghdr.what #21501
  • gh-85455: Add missing doc strings and improve docs #21573
    		•

    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 2021-04-02.15:58:46.823>
created_at = <Date 2020-07-12.09:20:31.943>
labels = ['type-feature', '3.8', 'docs']
title = 'The parameter name for imghdr.what in the documentation is wrong'
updated_at = <Date 2021-04-02.15:58:46.823>
user = 'https://github.com/aeltawela'

    bugs.python.org fields:

    activity = <Date 2021-04-02.15:58:46.823>
actor = 'ammar2'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-04-02.15:58:46.823>
closer = 'ammar2'
components = ['Documentation']
creation = <Date 2020-07-12.09:20:31.943>
creator = 'aeltawela'
dependencies = []
files = []
hgrepos = []
issue_num = 41283
keywords = ['patch']
message_count = 2.0
messages = ['373551', '374040']
nosy_count = 4.0
nosy_names = ['docs@python', 'ammar2', 'nanjekyejoannah', 'aeltawela']
pr_nums = ['21501', '21573']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue41283'
versions = ['Python 3.8']
    @aeltawela
    Copy link
    Mannequin Author

    aeltawela mannequin commented Jul 12, 2020

    I noticed the parameter name for imghdr.what in the documentation is wrong

    Link: https://docs.python.org/3.8/library/imghdr.html?highlight=imghdr
    function imghdr.what(filename, h=None)

    In reality:
    def what(file, h=None):

    It is 'file' not 'filename'.

    @aeltawela aeltawela mannequin added the 3.8 label Jul 12, 2020
    @aeltawela aeltawela mannequin assigned docspython Jul 12, 2020
    @aeltawela aeltawela mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement 3.8 labels Jul 12, 2020
    @aeltawela aeltawela mannequin assigned docspython Jul 12, 2020
    @aeltawela aeltawela mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Jul 12, 2020
    @nanjekyejoannah
    Copy link
    Member

    nanjekyejoannah commented Jul 21, 2020

    New changeset 5241e18 by Ammar Askar in branch 'master':
    bpo-41283: Fix mismatched argument name for imghdr.what (GH-21501)
    5241e18

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    @bedevere-bot bedevere-bot mentioned this issue Oct 15, 2022
    Merged
    nanjekyejoannah added a commit that referenced this issue Oct 15, 2022
    @nanjekyejoannah
    gh-85455: Add missing doc strings and improve docs (#21573)
    bf786e6 
    * Add missing doc strings and improve docs

* Use imperative form

* Modify docstring wording
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.8 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
    2 participants
    @ammaraskar @nanjekyejoannah