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

improve documentation on outputs #21

Open
samuelcolvin opened this issue Apr 3, 2023 · 1 comment · May be fixed by #22
Open

improve documentation on outputs #21

samuelcolvin opened this issue Apr 3, 2023 · 1 comment · May be fixed by #22
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@samuelcolvin
Copy link

samuelcolvin commented Apr 3, 2023

It's not that clear from the README how to use outputs.

It might help to include that "success" is the string, not the name of the variable set is result, also an example of usage.

I had to read the code to get this working.

Fund with Polar
@webknjaz
Copy link
Member

webknjaz commented Aug 9, 2023

Thanks, when I was adding the outputs, I mostly exposed them “just in case” with no testing or verification. I think it'd make more sense to guarantee that failure and success are booleans instead.

So there are three outputs: failure/success seem to be booleans and result is a string.

@webknjaz webknjaz added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants