Skip to content

Disposition docs#205

Open
javierggt wants to merge 3 commits intomasterfrom
disposition-docs
Open

Disposition docs#205
javierggt wants to merge 3 commits intomasterfrom
disposition-docs

Conversation

@javierggt
Copy link
Contributor

@javierggt javierggt commented Nov 6, 2025

Description

This PR fixes small things in the online documentation about the disposition of star-observations:

  • the command-line call to disposition a single observation is wrong in the docs
  • the docs do not include the meaning of the numeric values of the observation status (0=good, 1=bad)

Interface impacts

Testing

Unit tests

  • No unit tests
  • Mac
  • Linux
  • Windows
(aca_view_async) ~/SAO/git/agasc disposition-docs $ git rev-parse HEAD                             
be0af5170eae6f9bfefe82f617e9f1184cf61a63
(aca_view_async) ~/SAO/git/agasc disposition-docs $ pytest agasc 
============================================================== test session starts ===============================================================
platform darwin -- Python 3.12.8, pytest-8.3.4, pluggy-1.5.0
rootdir: /Users/javierg/SAO/git
configfile: pytest.ini
plugins: anyio-4.7.0, timeout-2.3.1
collected 79 items                                                                                                                               

agasc/tests/test_agasc_1.py .......                                                                                                        [  8%]
agasc/tests/test_agasc_2.py ..........sssss..........ss....................                                                                [ 68%]
agasc/tests/test_agasc_healpix.py .ssssssssss                                                                                              [ 82%]
agasc/tests/test_obs_status.py ..............                                                                                              [100%]

========================================================= 62 passed, 17 skipped in 6.68s =========================================================

Independent check of unit tests by [REVIEWER NAME]

  • [PLATFORM]:

Functional tests

The documentation generated from this PR can be seen here

To test the script, one can copy the file agasc_supplement.h5 into the local directory and run the command in the docs (and variations with/without comments, or using other possibilities of status like ok, good, 0, 1):

agasc-update-supplement --obs 11849 --agasc-id 1019348536 --status bad

…quired information, and correct the command-line command
…asc-supplement-tasks (the script used in standard processing) is not exactly the same as agasc-update-supplement.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant