NASA-AMMOS / NASA-AMMOS/AIT-Core

Add confirm box documentation to the API / script pages

Open
#348 0 comments 0 reactions 0 assignees View on GitHub

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:
Screen Shot 2021-05-03 at 13 24 11

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

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.