NASA-AMMOS / NASA-AMMOS/AIT-Core
Add confirm box documentation to the API / script pages
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 56
- Forks
- 35
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 3
Description
The confirm prompt functionality in the script API is largely undocumented. We should add a section to the relevant page(s) covering this.
Something like the following demonstrates this reasonably well.
import ait.core.api as api
import ait.core.log as log
log.info("Pre Confirm box")
if api.ui.confirm("Should we continue? Press Confirm"):
log.info("CONFIRM PRESSED")
else:
log.info("DENY PRESSED")
log.info("After Confirm box")
log.info("Pre failed confirm box")
if api.ui.confirm("Should we continue? DONT press Confirm"):
log.info("CONFIRM PRESSED")
else:
log.info("DENY PRESSED")
log.info("After failed Confirm box")
Example of the popup displayed:

Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by locating the API or script documentation page that covers api.ui.confirm and read the existing surrounding examples. Add a section explaining the confirm prompt, using the supplied Python example and popup image; done means the functionality is documented on the relevant page or pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100