Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DEE-171] Document the structure of the return value of checks in their docstring #2168

Open
noamzbr opened this issue Nov 27, 2022 · 0 comments
Labels
documentation modification of the documentation / readme's good first issue Good for newcomers

Comments

@noamzbr
Copy link
Collaborator

noamzbr commented Nov 27, 2022

Is your feature request related to a problem? Please describe.
Check parameters are well documented in the declaration of each check, but the structure of the return is either not documented for vision checks, or documented in run_logic() (which is inaccessible by users) for tabular checks

Describe the solution you'd like
Document the structure of the return value right below the parameter documentation, in the check declaration.

DEE-171

@noamzbr noamzbr added good first issue Good for newcomers documentation modification of the documentation / readme's labels Nov 27, 2022
@noamzbr noamzbr added this to the Mendel milestone Nov 27, 2022
@github-actions github-actions bot added the needs triage Issue needs to be labeled and prioritized label Nov 27, 2022
@noamzbr noamzbr removed the needs triage Issue needs to be labeled and prioritized label Nov 27, 2022
@ItayGabbay ItayGabbay modified the milestones: Mendel, Newton Dec 21, 2022
@ItayGabbay ItayGabbay changed the title Document the structure of the return value of checks in their docstring [DEE-171] Document the structure of the return value of checks in their docstring Jan 11, 2023
@ItayGabbay ItayGabbay removed the linear label Jan 11, 2023
@noamzbr noamzbr modified the milestones: Newton, Short-term Backlog Jan 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation modification of the documentation / readme's good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants