-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Missing documentation for some S3 Object methods #2681
Comments
Thanks for opening an issue. Yes, resource objects (such as Aws::S3::Object) leverage Client API operation methods (such as multipart upload) and have their own documentation. Client API methods are code generated from the API source. I think we can probably add some YARD references to those operations. |
@mullermp if there's an example you can link me to I can try to tackle this. The other thing will be just to add a reference, some basic wording on the YARD documentation something like "This method shares all options from this other method". I think this will be enough. |
Sure, taking Under
At the very bottom:
To be thorough (if you're up for it), this kind of pattern should be done for all methods in aws-sdk-s3/customizations/. |
|
Describe the issue with documentation
There are some methods that are missing documentation for their optional parameters. I haven't used all methods in the
Aws::S3::Object
class so I can't talk for all of them, but for exampleupload_file
only reflects 3 optional parametersmultipart_threshold
,thread_count
, andprogress_callback
but the reality is that it uses multipart upload code and for that reason it inherits all of the options available in that method too. The same thing happens with thecopy_to
andcopy_from
methods.I hope I made the point clear if not I can elaborate further.
Thanks,
Alberto
The text was updated successfully, but these errors were encountered: