powertools-lambda-typescript icon indicating copy to clipboard operation
powertools-lambda-typescript copied to clipboard
verified publisher icon aws-powertools

docs(parser): add docs for parser utility

Open am29d opened this issue 1 year ago • 1 comments

Description of your changes

This PR adds documentation section for the parser utility. The main structure is aligned with the current python documentation, except "Advanced use cases", since we don't generate models from JSON/object strucutre.

I have also used this PR to adjust the exports.

Related issues, RFCs

Issue number: closes #1796

Checklist

  • [x] My changes meet the tenets criteria
  • [x] I have performed a self-review of my own code
  • [x] I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • [x] I have made corresponding changes to the documentation
  • [x] My changes generate no new warnings
  • [ ] I have added tests that prove my change is effective and works
  • [x] The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • [ ] I have documented the migration process
  • [ ] I have added, implemented necessary warnings (if it can live side by side)

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

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

am29d avatar Jan 04 '24 10:01 am29d

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
31.2% Duplication on New Code

See analysis details on SonarCloud

sonarqubecloud[bot] avatar Jan 05 '24 15:01 sonarqubecloud[bot]

I think there's something wrong with the formatting of the main index docs page (that's what I was trying to point out in the past few comments).

Not sure if intentional or automatic, but removing these indentations will break all the callouts.

Ah, there was some weird indentation during merge. I have checked the collapsing callouts in the index.md it should be good now.

am29d avatar Apr 05 '24 07:04 am29d

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
37.5% Duplication on New Code

See analysis details on SonarCloud

sonarqubecloud[bot] avatar Apr 05 '24 11:04 sonarqubecloud[bot]