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.

Sign up for GitHub

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

Jump to bottom

Standardize method of documenting errors in function headers #458

Open
Danp2 opened this issue Apr 21, 2023 · 3 comments
Open

Standardize method of documenting errors in function headers #458

Danp2 opened this issue Apr 21, 2023 · 3 comments

Comments

@Danp2
Copy link
Owner

Danp2 commented Apr 21, 2023

See prior discussion in #444
@mlipok

This comment was marked as off-topic.

Sign in to view
@Danp2

This comment was marked as off-topic.

Sign in to view
@Danp2
Copy link
Owner Author

Danp2 commented Apr 30, 2023 •
edited

Some related discussions --

#444 (comment)

#437

Also, this is from the wiki --

Return values

Details what is returned by the function. This often comes in the form of Success and Failure values, but this is not always the case. Any setting of the @error of @extended flags should be detailed, along with their meanings, in some cases it is enough to say that @error is set to non-zero in the event of an error, in most cases though a list of values for @error should be given.

@Danp2 Danp2 changed the title Standardize method of documenting errrors in function headers Standardize method of documenting errors in function headers Apr 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Danp2 @mlipok