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

unittest.mock.sentinel documentation typo #88845

Closed
GaidaiAndrii mannequin opened this issue Jul 19, 2021 · 5 comments
Closed

unittest.mock.sentinel documentation typo #88845

GaidaiAndrii mannequin opened this issue Jul 19, 2021 · 5 comments
Labels
docs Documentation in the Doc dir

Comments

@GaidaiAndrii
Copy link
Mannequin

GaidaiAndrii mannequin commented Jul 19, 2021

BPO 44679
Nosy @ambv, @miss-islington, @jdevries3133, @GaidaiAndrii
PRs
  • bpo-44679: [doc] fix typo in unittest.mock.rst #27618
  • [3.9] bpo-44679: [doc] fix typo in unittest.mock.rst (GH-27618) #27619
  • [3.10] bpo-44679: [doc] fix typo in unittest.mock.rst (GH-27618) #27620
  • 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-08-05.20:52:00.921>
    created_at = <Date 2021-07-19.21:15:28.426>
    labels = ['docs']
    title = 'unittest.mock.sentinel documentation typo'
    updated_at = <Date 2021-08-06.15:38:31.290>
    user = 'https://github.com/GaidaiAndrii'

    bugs.python.org fields:

    activity = <Date 2021-08-06.15:38:31.290>
    actor = 'lukasz.langa'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2021-08-05.20:52:00.921>
    closer = 'Mariatta'
    components = ['Documentation']
    creation = <Date 2021-07-19.21:15:28.426>
    creator = 'gaydayav'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 44679
    keywords = ['patch']
    message_count = 5.0
    messages = ['397839', '399035', '399039', '399041', '399098']
    nosy_count = 5.0
    nosy_names = ['docs@python', 'lukasz.langa', 'miss-islington', 'jack__d', 'gaydayav']
    pr_nums = ['27618', '27619', '27620']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue44679'
    versions = ['Python 3.6']

    @GaidaiAndrii
    Copy link
    Mannequin Author

    GaidaiAndrii mannequin commented Jul 19, 2021

    here: 
        https://docs.python.org/3.3/library/unittest.mock.html#sentinel
    in code example block in last command line
        >>> sentinel.some_object
    according to the above 26.4.5.1 article context it looks like the other commad is expected:
        >>> result
    To ensure that at the end "result" equals sentinel.some_object we probably should print the "result" value to check, not the "sentinel.some_object" itself.

    @GaidaiAndrii GaidaiAndrii mannequin assigned docspython Jul 19, 2021
    @GaidaiAndrii GaidaiAndrii mannequin added the docs Documentation in the Doc dir label Jul 19, 2021
    @jdevries3133
    Copy link
    Mannequin

    jdevries3133 mannequin commented Aug 5, 2021

    @gaydayav I agree.

    @miss-islington
    Copy link
    Contributor

    New changeset 938e84b by Jack DeVries in branch 'main':
    bpo-44679: [doc] fix typo in unittest.mock.rst (GH-27618)
    938e84b

    @Mariatta Mariatta closed this as completed Aug 5, 2021
    @miss-islington
    Copy link
    Contributor

    New changeset 0a642d5 by Miss Islington (bot) in branch '3.10':
    bpo-44679: [doc] fix typo in unittest.mock.rst (GH-27618)
    0a642d5

    @ambv
    Copy link
    Contributor

    ambv commented Aug 6, 2021

    New changeset 8c17db6 by Miss Islington (bot) in branch '3.9':
    bpo-44679: [doc] fix typo in unittest.mock.rst (GH-27618) (GH-27619)
    8c17db6

    @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

    3 participants