Document leaky exceptions

Open
#164 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
api, documentation

Research direction

Start by reading the API client documentation and reproducing the exception behavior attributed to fastcore.net. Document which exceptions users should handle, while clarifying whether the current GhApi behavior or a separate exception design is in scope; done means the supported exception handling is explicit in the docs.

Written by the indexing model from the issue text.

Description

Documentation does not appear to mention exceptions. Experimentally, this appears to raise fastcore.net HTTP exceptions, which unfortunately leaks that abstraction; ideally I think the API would raise its own GhApi exceptions.

In either case though, users should be able to read the docs to see what exceptions they should handle.

Dominant language
Python
Stars
687
Forks
69
Avg merge
1m
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AnswerDotAI/ghapi

All issues in AnswerDotAI/ghapi

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.