Follow Style Guide
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by reading the linked LFRic Core documentation style guide and comparing it with the repository's current working practices. Identify the documentation guidance that differs and update the relevant practices so they consistently follow the guide.
Written by the indexing model from the issue text.
Description
The LFRic Core style guide for sphinx documentation is very close to what we currently do in the working practices. It would seem sensible to make sure we are following this and then stick to it from now on.
https://metoffice.github.io/lfric_core/how_to_contribute/style_guides/documentation_style_guide.html
- Dominant language
- Python
- Stars
- 57
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from MetOffice/simulation-systems
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
MetOffice/simulation-systems#661 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
MetOffice/simulation-systems#652 ·
-
:blue_book:Documentation
Difficulty 1/5 Under an hour Newbie friendliness 68/100
MetOffice/simulation-systems#588 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 25/100
MetOffice/simulation-systems#682 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
MetOffice/simulation-systems#604 · 1 comment ·
All issues in MetOffice/simulation-systems
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
NousResearch/hermes-agent#136483 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
[BUG] LazyStackedTensorDictStore zeroes the last byte of a new key set on the last elementPossibly taken @peterdsharpe claimed this today. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
pytorch/tensordict#2307 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
GrokModel.generate/a_generate pass an OpenAI-style list-of-dicts to xai_sdk.chat.user(), so every call crashes with a protobuf TypeError before any network I/OPossibly taken @Christian-Sidak claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
confident-ai/deepeval#3436 · 1 comment ·
Maintainers usually reply within 1 day