Skip to content

Argument Clinic How-To needs more examples #1190

Description

@littlebutt

Documentation

Currently, the example for AC How-To is the method _pickle.Pickler.dump. I think it is not proper since it cannot cover all cases and makes readers confused. A more intuitive example should be considered to replace the current one.

Linked PRs

Activity

  1. erlend-aasland commented on Jul 17, 2023

    @erlend-aasland
    Contributor

    I think it is not proper since it cannot cover all cases and makes readers confused. A more intuitive example should be considered to replace the current one.

    Can you elaborate? Which cases are not covered, what is confusing, and what is a more intuitive example? :)

  2. littlebutt commented on Jul 17, 2023

    @littlebutt
    Author

    I think it is not proper since it cannot cover all cases and makes readers confused. A more intuitive example should be considered to replace the current one.

    Can you elaborate? Which cases are not covered, what is confusing, and what is a more intuitive example? :)

    In the chapter Converting Your First Function, some steps don't have Sample. For example, in step 5, it says:

    (Our example docstring consists solely of a summary line, so the sample code doesn’t have to change for this step.)

    In step 9, it says:

    (_pickle.Pickler.dump has neither, so our sample is unchanged.)

    I picked another function _asyncio.Future.add_done_callback and it can cover these steps rightly. Actually, I refered this function when I was learning AC.

  3. added
    type-bugEditing of existing content needed
    type-featureAdditions; New content or section needed
    on Oct 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    type-featureAdditions; New content or section needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions