Docs-- TemplateLoaders could use some inline docs ; perhaps a base class.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 59
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
It took a bit more trial & error to figure out my issues with the TemplateLoaders.
I'd suggest switching the library to use a "BaseTemplateLoader" class , which has full inline documentation for whatever methods and arguments are supported, and then having the 2 other classes inherit from it. Basically, implement the Loaders the same way the AshesEnv is implemented -- but with a bit more docs.
The 'BaseAshesEnv' could also use some more docs around load/load_all/init. .
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the TemplateLoaders implementations and BaseAshesEnv. Read how AshesEnv defines load, load_all, and init, then compare the loader methods and arguments. Done means the loaders share the proposed base structure and the supported loader and environment APIs have complete inline documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100