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

Document tolerance for null pointers in specific function parameters #2837

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

Comments

@elfring
Copy link
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
Copy link
Member

bagder commented Aug 6, 2018

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

@bagder
Copy link
Member

bagder commented Aug 8, 2018

Are you willing to write up a PR for this?

@elfring
Copy link
Contributor Author

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
@bagder bagder closed this as completed in 6fac5a3 Aug 9, 2018
@elfring
Copy link
Contributor Author

elfring commented Aug 10, 2018

xquery pushed a commit to xquery/curl that referenced this issue Sep 3, 2018
falconindy pushed a commit to falconindy/curl that referenced this issue Sep 10, 2018
@lock lock bot locked as resolved and limited conversation to collaborators Nov 8, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Development

No branches or pull requests

2 participants