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

Missing cross-reference links #3787

Open
tim-finnigan opened this issue Jul 18, 2023 · 1 comment · May be fixed by #3863
Open

Missing cross-reference links #3787

tim-finnigan opened this issue Jul 18, 2023 · 1 comment · May be fixed by #3863
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue

Comments

@tim-finnigan
Copy link
Contributor

tim-finnigan commented Jul 18, 2023 •
edited

Describe the issue

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3/client/get_paginator.html
image

Should this link to Paginators?

And should get_waiter methods should link to https://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters?

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3/client/upload_file.html

see boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS should link to https://boto3.amazonaws.com/v1/documentation/api/latest/reference/customizations/s3.html#boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS
image

(Same issue with boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS)
@tim-finnigan tim-finnigan added documentation This is a problem with documentation. p3 This is a minor priority issue labels Jul 18, 2023
@tim-finnigan
Copy link
Contributor Author

After discussing with the team: botocore.paginate.Paginator and botocore.waiter.Waiter shouldn't have links but should both be in markdown and without the 'L{...}' currently around botocore.paginate.Paginator.

The "see boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS" issue is valid and should link directly to Args or at least this section for reference: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/customizations/s3.html#boto3.s3.transfer.S3Transfer

This was referenced Sep 20, 2023
Merged
Open
@tim-finnigan tim-finnigan linked a pull request Sep 20, 2023 that will close this issue
Add internal links to S3 upload/download args #3863
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add internal links to S3 upload/download args tim-finnigan/boto3
1 participant
@tim-finnigan