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

Document tolerance for null pointers in specific function parameters #2837

Closed
elfring opened this Issue Aug 6, 2018 · 4 comments

Comments

Projects
None yet
2 participants
@elfring
Contributor

elfring commented Aug 6, 2018

Some functions are implemented in the way that they check if a null pointer was passed as an input parameter. These functions return then immediately.

Examples:

Can such a detail become an official property in the affected application programming interface?
How would you like to represent information about existing input parameter validation in the corresponding API documentation?

@bagder bagder added the documentation label Aug 6, 2018

@bagder

This comment has been minimized.

Show comment
Hide comment
@bagder

bagder Aug 6, 2018

Member

That should probably be mentioned in the man pages for those functions.

Member

bagder commented Aug 6, 2018

That should probably be mentioned in the man pages for those functions.

@bagder bagder added the help wanted label Aug 8, 2018

@bagder

This comment has been minimized.

Show comment
Hide comment
@bagder

bagder Aug 8, 2018

Member

Are you willing to write up a PR for this?

Member

bagder commented Aug 8, 2018

Are you willing to write up a PR for this?

@elfring

This comment has been minimized.

Show comment
Hide comment
@elfring

elfring Aug 8, 2018

Contributor

Perhaps.

  • I am looking for an acknowledgement from the main developers of this software for the mentioned technical detail before.
  • Other designers expressed similar details in different ways for API documentations already. Which wording will get the desired consensus?
Contributor

elfring commented Aug 8, 2018

Perhaps.

  • I am looking for an acknowledgement from the main developers of this software for the mentioned technical detail before.
  • Other designers expressed similar details in different ways for API documentations already. Which wording will get the desired consensus?

bagder added a commit that referenced this issue Aug 9, 2018

docs: mention NULL is fine input to several functions
Fixes #2837
Reported-by: Markus Elfring

@bagder bagder closed this in 6fac5a3 Aug 9, 2018

@elfring

This comment has been minimized.

Show comment
Hide comment
@elfring
Contributor

elfring commented Aug 10, 2018

xquery added a commit to xquery/curl that referenced this issue Sep 3, 2018

docs: mention NULL is fine input to several functions
Fixes #2837
Closes #2858
Reported-by: Markus Elfring

falconindy added a commit to falconindy/curl that referenced this issue Sep 10, 2018

docs: mention NULL is fine input to several functions
Fixes #2837
Closes #2858
Reported-by: Markus Elfring
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment