Skip to content

Use boto3 intersphinx inventory in documentation/docstrings. - #28945

Merged
kaxil merged 1 commit into
apache:mainfrom
Taragolis:boto3-intersphinx-references
Jan 14, 2023
Merged

kaxil merged 1 commit into
apache:mainfrom
Taragolis:boto3-intersphinx-references

Conversation

@Taragolis

Copy link
Copy Markdown
Contributor

Update Amazon Provider documentation and Hooks docstrings with references to Intersphinx Inventory

  1. Make Hooks docstring more consistant to each other. Mark each hook which is intend to be a wrapper to boto3 client/resource is it Thin (provide only arguments described in AwsBaseHook) wrapper or Think (contain additional arguments in constructor)
  2. Add links to appropriate boto3 client/resource method/class in hooks methods doctrings, if applicable
  3. Remove useless type hinting for params / returns in docstring - we have annotation for that.
  4. Most of the references use prefix :external+boto3: for avoid overlapping with botocore inventory, we do not use this inventory yet.

There is quite a few changes, if someone interested I attach archive with locally built documentation.

@kaxil
kaxil merged commit 198e96a into apache:main Jan 14, 2023
@potiuk

potiuk commented Jan 15, 2023

Copy link
Copy Markdown
Member

Nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants