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

Jump to bottom

CURLOPT_READFUNCTION doc should be improved #3885

Closed
RoyBellingan opened this issue May 14, 2019 · 6 comments
Closed

CURLOPT_READFUNCTION doc should be improved #3885

RoyBellingan opened this issue May 14, 2019 · 6 comments
Labels
documentation

Comments

@RoyBellingan
Copy link

It would be nice to have a reference function implementation that shows how should be used, like https://curl.haxx.se/libcurl/c/getinmemory.html for https://curl.haxx.se/libcurl/c/CURLOPT_WRITEFUNCTION.html

In addition the page https://curl.haxx.se/libcurl/c/CURLOPT_UPLOAD_BUFFERSIZE.html has a link to https://curl.haxx.se/libcurl/c/CURLOPT_READFUNCTION.html but not the opposite.
@jay jay changed the title https://curl.haxx.se/libcurl/c/CURLOPT_READFUNCTION.html should be improoved CURLOPT_READFUNCTION doc should be improved May 14, 2019
@jay
Copy link
Member

jay commented May 14, 2019

The EXAMPLE section links to https://curl.haxx.se/libcurl/c/ftpupload.html is that not sufficient?

@bagder
Copy link
Member

bagder commented May 14, 2019

That option is used by numerous examples, for example ftpuploadfrommem.

bagder added a commit that referenced this issue May 15, 2019
@bagder
CURLOPT_READFUNCTION.3: see also CURLOPT_UPLOAD_BUFFERSIZE [ci skip]
f778c35 
Reported-by: Roy Bellingan
Bug: #3885
@bagder
Copy link
Member

bagder commented May 15, 2019

Apart from that little fix I don't see any actionable item here. @RoyBellingan can you elaborate on what specifically the existing documentation for this option doesn't cover?

@RoyBellingan
Copy link
Author

@bagder I have never seen the ftpuploadfrommem ! I think just having this one linked is enough!
@jay No sorry, in that example the comment in the function says ... that well this is just an example, and real world usage will be different

@bagder
Copy link
Member

bagder commented May 15, 2019

real world usage will be different

But that goes for all examples! They are after all examples, we don't expect any of them to be used exactly verbatim by people. They're there to show how the APIs are used and that example does show how the API is used even if the exact implementation possibly won't be used in applications.

@jay
Copy link
Member

jay commented May 16, 2019

I agree. Examples are just that, examples.

@jay jay closed this as completed May 16, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Aug 14, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation
Milestone
No milestone
Development

No branches or pull requests
3 participants
@bagder @RoyBellingan @jay