Add comments to obs_status.yml with process help

[taldcroft]

Description

This PR puts much of the necessary information for supplement disposition and promotion into the RC obs_status.yml file.

Testing

• [n/a] Passes unit tests on MacOS, linux, Windows (at least one required)
• Functional testing

Functional testing

From @javierggt:

I did the following test:

mkdir test
cd test
echo 5115672 > agasc_ids
agasc-update-magnitudes --agasc-id-file agasc_ids

and checked that the obs_status file was there and with the expected output. Then I edited the file, amended the supplement in the current directory, and checked that it was ok:

agasc-update-supplement --output-dir `pwd` --obs-status-file obs_status.yml 

[javierggt]

Looks ok to me. Since we are adding a detailed description of steps to follow, we might as well add a link to the diff that is generated after applying the dispositions.

As a test, one can run something like what is run in the workflow, which should produce an obs_status file, and then apply that to make sure it runs ok. I can do that. I do not foresse a problem, given that all changes are in comments.

[taldcroft]

@javierggt - I added a link to the diffs per your suggestion. If you can do some functional test that would be great!

[javierggt]

I did the following test:

mkdir test
cd test
echo 5115672 > agasc_ids
agasc-update-magnitudes --agasc-id-file agasc_ids

and checked that the obs_status file was there and with the expected output. Then I edited the file, amended the supplement in the current directory, and checked that it was ok:

agasc-update-supplement --output-dir `pwd` --obs-status-file obs_status.yml