RadioAstronomySoftwareGroup / RadioAstronomySoftwareGroup/pyuvdata
Create UVFlag Tutorials
Open
Nobody has claimed this yet.
uvflag
- Dominant language
- Python
- Stars
- 102
- Forks
- 35
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 14
Description
Tutorials for UVFlag are all but non-existant at the moment. We should make a tutorial for them that is made as part of the online docs.
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
Start by locating the online documentation structure and existing tutorials for related pyuvdata components, then identify where UVFlag tutorials belong. Review the UVFlag API and current documentation conventions before defining the tutorial scope. Done means the online docs include a clear, tested UVFlag tutorial.
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