Skip to content

Minor Documentation Improvements#1259

Merged
TheRealFalcon merged 1 commit into
canonical:mainfrom
eslerm:docs
Feb 10, 2022
Merged

Minor Documentation Improvements#1259
TheRealFalcon merged 1 commit into
canonical:mainfrom
eslerm:docs

Conversation

@eslerm
Copy link
Copy Markdown

@eslerm eslerm commented Feb 10, 2022

Proposed Commit Message

Minor Documentation Improvements

Summary: Minor Documentation Improvements

Primarily improved grammar for clarity.

A few Sphinx/RST syntax fixes.

Set text width to 79 characters per footer documnentaiton where needed.

Changed "yaml" to "YAML" when used in sentences.

Test Steps

Checked with tox -e doc and verified Sphinx/RST syntax fixes in
generated HTML files manually.

Checklist:

  • My code follows the process laid out in the documentation
  • I have updated or added any unit tests accordingly
  • I have updated or added any documentation accordingly


datasources/aliyun.rst
datasources/altcloud.rst
datasources/ec2.rst
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes the rendered HTML list alphabetical (i.e., Amazon Ec2).

@eslerm eslerm marked this pull request as ready for review February 10, 2022 20:14
Copy link
Copy Markdown
Contributor

@TheRealFalcon TheRealFalcon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @eslerm , this is a nice set of improvements.

@TheRealFalcon TheRealFalcon merged commit cbe840a into canonical:main Feb 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants