mars-project / mars-project/mars
Explain `enter_mode` in doc
Open
Nobody has claimed this yet.
type: docs
- Dominant language
- Python
- Stars
- 2.7k
- Forks
- 325
- PR merge metrics
- No merged PRs in 30d
Description
`enter_mode` stuff is a bit confusing for new core developers, we need to add some docs and comments to explain what they are.
Contributor guide
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
No file, test, or entry point is named. Start by locating the implementation and references for `enter_mode`, then read the surrounding code to determine what the modes mean and where comments or documentation belong. Done means new core developers can understand the purpose and behavior of `enter_mode` from the added explanations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100