cyclus / cyclus/cyclus.github.com

[Task] Fix Typos in the User Tutorial

Open Beginner friendly
#454 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8
Forks
33
PR merge metrics
No merged PRs in 30d

Description

What is this task about?

There are a few typos in the User Tutorial. They should be corrected.

Why is this task needed?

Typos are bad.

Relevant resources or references

How can this issue be closed?

Ideally someone would comb through the CYCLUS user tutorial with a dictionary and a fine toothed comb, but that sounds tedious, so maybe I'll just add a bunch of typos to this issue as checkboxes and tick them off and then have Codex run through all the files and take a look for typos as well.

Typos

  • This page, under "Activity: Adding archetypes", it says: "cycamore Enrichment:to act as the enrichment facility" there should be a space between : and to
  • This page, under "Check: Complete Recipe block" there is a missing / in the </name> tag for <name>spent_uox<name>.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the two linked User Tutorial pages and locate the sections named in the checklist: “Activity: Adding archetypes” and “Check: Complete Recipe block.” Correct the missing space and slash described there, then review both pages to confirm the listed typos are fixed and the tutorial markup remains correct.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.