Skip to content

Missing documentation for Exceptions #940

Closed

Description

@hynek

So looked everywhere but I could't find any information on httpx's errors at all (except of the existence of raise_for_status(). Is this on purpose because the design is not final? I had to read source code to get an idea which is not ideal.

Activity

  1. lovelydinosaur commented on May 12, 2020

    @lovelydinosaur
    Member

    Not intentional, nope.

    Or, it might have been at one point, but right now anything that's visible through __init__.py is public API, and ought to be documented.

    It'd make sense for us to prioritize this one.

  2. florimondmanca commented on May 12, 2020

    @florimondmanca
    Contributor

    FWIW we have #884 pending to add some docs about exceptions. :)

  3. lovelydinosaur commented on May 12, 2020

    @lovelydinosaur
    Member

    Ah, thanks @florimondmanca, I'll close this one off as a duplicate.

  4. hynek commented on May 12, 2020

    @hynek
    ContributorAuthor

    I have seen those but it looked like stalled attempt to refactor the exceptions, not like documentation for the status quo…

  5. lovelydinosaur commented on May 13, 2020

    @lovelydinosaur
    Member

    @hynek Yeah that's actually a fair comment. Opened #949 to make sure we address this comprehensively.

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

    docsChanges to the documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions