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

add missing doc lint and and missing docs to all runtime crates #857

Open
20 of 26 tasks
Tracked by #763
rcoh opened this issue Nov 12, 2021 · 0 comments
Open
20 of 26 tasks
Tracked by #763

add missing doc lint and and missing docs to all runtime crates #857

rcoh opened this issue Nov 12, 2021 · 0 comments
Labels
client documentation Improvements or additions to documentation
Milestone

Comments

@rcoh
Copy link
Collaborator

rcoh commented Nov 12, 2021

Add the missing_docs and missing_crate_level_docs lints to all the runtime crates. For example:

#![warn(
    missing_docs,
    rustdoc::missing_crate_level_docs,
)]

AWS runtime crates:

  • aws-config
  • aws-endpoint (deprecated)
  • aws-http
  • aws-hyper (deprecated)
  • aws-inlineable
  • aws-sig-auth (deprecated)
  • aws-sigv4
  • aws-types
  • aws-credential-types
  • aws-runtime
  • aws-runtime-api

Smithy runtime crates:

  • aws-smithy-async
  • aws-smithy-checksums
  • aws-smithy-client (deprecated)
  • aws-smithy-eventstream
  • aws-smithy-http
  • aws-smithy-http-tower (deprecated)
  • aws-smithy-json
  • aws-smithy-protocol-test
  • aws-smithy-query
  • aws-smithy-runtime
  • aws-smithy-runtime-api
  • aws-smithy-types
  • aws-smithy-types-convert
  • aws-smithy-wasm
  • aws-smithy-xml
@rcoh rcoh added the documentation Improvements or additions to documentation label Nov 12, 2021
@rcoh rcoh added this to the Dev Preview milestone Nov 12, 2021
@rcoh rcoh self-assigned this Nov 19, 2021
@rcoh rcoh modified the milestones: Dev Preview, GA Dec 8, 2021
@jdisanti jdisanti removed the sdk-ga label Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants