Skip to content

chore(docs): remove missing README from typedoc for jmespath temporarily #2200

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

Merged
merged 1 commit into from
Mar 11, 2024

Conversation

am29d
Copy link
Contributor

@am29d am29d commented Mar 11, 2024

Description of your changes

This PR removes readme field from the api typedoc configuration. This will unblock the docs workflow, so we can publish docs until #2186 is merged.

Related issues, RFCs

Issue number: closes #2199

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • 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 am29d requested review from dreamorosi and a team March 11, 2024 12:52
@am29d am29d requested a review from a team as a code owner March 11, 2024 12:52
@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label Mar 11, 2024
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

@am29d am29d self-assigned this Mar 11, 2024
@dreamorosi dreamorosi merged commit 6503cad into main Mar 11, 2024
16 checks passed
@dreamorosi dreamorosi deleted the docs/remove-jmespath-from-api-docs branch March 11, 2024 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XS PR between 0-9 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: temporarily remove README from jsmespath typedoc
2 participants