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

fix(apidoc): repair generated links #514

Merged
merged 6 commits into from
Aug 4, 2022
Merged

fix(apidoc): repair generated links #514

merged 6 commits into from
Aug 4, 2022

Conversation

sranka
Copy link
Contributor

@sranka sranka commented Aug 4, 2022

Fixes #513

Proposed Changes

  • doc reviewed and improved
  • change generated API links to point to InfluxDB v2.3
  • change unsupported markdown links to TSdoc links before generation of API docs

Checklist

  • CHANGELOG.md updated
  • Rebased/mergeable
  • yarn test completes successfully
  • Commit messages are conventional

@sranka sranka changed the title fix(apidoc): repair generated link fix(apidoc): repair generated links Aug 4, 2022
@sranka sranka added this to the 1.29.0 milestone Aug 4, 2022
@sranka sranka requested review from vlastahajek and bednar August 4, 2022 06:36
@sranka sranka marked this pull request as ready for review August 4, 2022 06:36
@codecov-commenter
Copy link

codecov-commenter commented Aug 4, 2022

Codecov Report

Merging #514 (d47f843) into master (e1e8b72) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #514   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           33        33           
  Lines         1256      1256           
  Branches       302       302           
=========================================
  Hits          1256      1256           
Impacted Files Coverage Δ
packages/core/src/query/flux.ts 100.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@sranka sranka force-pushed the 513/doc_comments branch from 0498d57 to d47f843 Compare August 4, 2022 06:38
Copy link
Contributor

@bednar bednar left a comment

Choose a reason for hiding this comment

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

Maybe we can change InfluxDB's links to latest version.

LGTM 🍻

@@ -39,7 +39,7 @@ function isFluxParameterLike(value: any): boolean {

/**
* Escapes content of the supplied string so it can be wrapped into double qoutes
* to become a [flux string literal](https://docs.influxdata.com/flux/v0.65/language/lexical-elements/#string-literals).
* to become a [flux string literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#string-literals).
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe the latest will be better:

Suggested change
* to become a [flux string literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#string-literals).
* to become a [flux string literal](https://docs.influxdata.com/flux/latest/spec/lexical-elements/#string-literals).

@sranka sranka merged commit 81c7f55 into master Aug 4, 2022
@sranka sranka deleted the 513/doc_comments branch August 4, 2022 07:46
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.

Repair links in doc comments
3 participants