ukaea/neutronics_material_maker

Fixing typo with material number in the docs

Closed this issue · 1 comments

I just noticed that one of the examples in the documentation is wrong. It is only a two character typo but I think this is a opportunity for an easy first issue.

So I'm going to spend more time writing it up than is needed to actually do to the task in the hope that someone can have practice contributing to an open source project.

The docs are made from rst files and line 204 of this file is slightly wrong
https://github.com/ukaea/neutronics_material_maker/blob/main/docs/source/example_material.rst

It should as M24 001001 6.66562840e-01 instead of M10 001001 6.66562840e-01

If anyone is keen to make a pull request to fix this tiny problem and go through the git clone, git fork, git add, git commit etc along the way then I am available to walk them through the process via zoom. Just book me up wit the calendy link and assignee yourself to the task (button in top right) to avoid having duplicate people trying to solve this one.

The Continuous integration on this repo builds the documentation with each PR so the tiny chance can be observed the fix in a draft deployment of the documentation before we merge

  1. Assign yourself to this issue
  2. Complete the PR or book up a zoom session and we can do it together https://calendly.com/shimwell/30min