Skip to content

Conversation

michaelbrewer
Copy link
Contributor

@michaelbrewer michaelbrewer commented Aug 11, 2021

Issue #, if available:

Description of changes:

Changes:

  • Correct the readme me link to feature flags correct location is https://awslabs.github.io/aws-lambda-powertools-python/latest/utilities/feature_flags/
  • Fix some of the json examples in feature_flags.md
  • run markdownlint against all of the *.md files

Unfortunately alot of white space changes, so in the diff Hide whitespace changes make help hide the noise

Checklist

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 11, 2021
@heitorlessa
Copy link
Contributor

awesome, while you're at it, could you also include this small fix here? The closing is invalid

https://github.com/awslabs/aws-lambda-powertools-python/blob/f627b02ee3fb52859a620413bb8310c74c778046/docs/utilities/feature_flags.md#L373

@pull-request-size pull-request-size bot removed the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 11, 2021
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Aug 11, 2021
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 11, 2021
@michaelbrewer
Copy link
Contributor Author

awesome, while you're at it, could you also include this small fix here? The closing is invalid

https://github.com/awslabs/aws-lambda-powertools-python/blob/f627b02ee3fb52859a620413bb8310c74c778046/docs/utilities/feature_flags.md#L373

done. there is also general formatting issues with the json

@codecov-commenter
Copy link

codecov-commenter commented Aug 11, 2021

Codecov Report

Merging #603 (aaf817e) into develop (f627b02) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #603   +/-   ##
========================================
  Coverage    99.95%   99.95%           
========================================
  Files          113      113           
  Lines         4535     4535           
  Branches       246      246           
========================================
  Hits          4533     4533           
  Partials         2        2           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f627b02...aaf817e. Read the comment docs.

@pull-request-size pull-request-size bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 11, 2021
@pull-request-size pull-request-size bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 12, 2021
@michaelbrewer
Copy link
Contributor Author

@heitorlessa - I run through all of the markdown files through vs code - markdownlint, see what you think

@heitorlessa
Copy link
Contributor

1.8K changes hahaha perhaps we split into a separate PR so we know we experimented with markdown linting?

@michaelbrewer
Copy link
Contributor Author

1.8K changes hahaha perhaps we split into a separate PR so we know we experimented with markdown linting?

Minimal changes here: #605

@michaelbrewer
Copy link
Contributor Author

@heitorlessa i synced up the changes. So if you want to look at the impact this. I think once you have the linting working nicely. The impact will be less for future updates.

@heitorlessa
Copy link
Contributor

Does it render correctly in the docs after all changes? and if you were to copy/paste the code snippets from docs, does it still work correctly e.g. indentation?

Haven't had a chance to pull this PR and try these, so I'd trust if you say so and merge it ;)

@michaelbrewer
Copy link
Contributor Author

@heitorlessa - it does in my random testing. But I will have to think of a faster way to validate all of them.

@heitorlessa heitorlessa added this to the 1.20.0 milestone Aug 15, 2021
@heitorlessa heitorlessa merged commit f7cd398 into aws-powertools:develop Aug 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants