biocore / biocore/microsetta-private-api
Refactor Hardcoded Error Messages
- Dominant language
- Python
- Stars
- 6
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
Error messages are hardcoded either in exceptions or as return values in implementation. If these are to be displayed to the end user, we should use the language_tag fields we have to localize them. If these are instead handled by other developers and they require more than just the HTTP error code, we should number possible errors and return that error value so developers can switch on how to handle them.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by inventorying the implementation's hardcoded messages in exceptions and return values, then inspect how language_tag fields and HTTP error codes are currently handled. Separate messages intended for end users from errors consumed by other developers. Done means the project has a decided, consistently applied approach for localization or numbered error values, with affected API behavior documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend, internationalization
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100