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(docs): use better links in code #173

Merged
merged 4 commits into from
Apr 15, 2020
Merged

fix(docs): use better links in code #173

merged 4 commits into from
Apr 15, 2020

Conversation

sranka
Copy link
Contributor

@sranka sranka commented Apr 14, 2020

Fixes #172

Proposed Changes

Remove all @see doc comments and replace them with plain links or Markdown https://typedoc.org/guides/doccomments/

Checklist

  • CHANGELOG.md updated
  • yarn test completes successfully
  • Commit messages are in semantic format
  • Sign CLA (if not already signed)

@sranka sranka changed the title fix(docs): use better links in code #172 fix(docs): use better links in code Apr 14, 2020
@sranka sranka requested a review from bednar April 14, 2020 20:18
Copy link

@nmummau nmummau left a comment

Choose a reason for hiding this comment

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

@sranka If you do something like {@link https://v2.docs.influxdata.com/v2.0/api/#operation/GetAuthorizations https://v2.docs.influxdata.com/v2.0/api/#operation/GetAuthorizations} then in developer interface like VSCode it will show up as a link rather than just a string.

Maybe using markdown like you did works too. I haven't tried that.

@codecov-io
Copy link

Codecov Report

Merging #173 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #173   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           23        22    -1     
  Lines          708       697   -11     
  Branches       146       146           
=========================================
- Hits           708       697   -11     
Impacted Files Coverage Δ
packages/core/src/Point.ts 100.00% <ø> (ø)
packages/core/src/options.ts 100.00% <ø> (ø)
packages/core/src/query/FluxTableColumn.ts 100.00% <ø> (ø)
packages/core/src/query/FluxTableMetaData.ts 100.00% <ø> (ø)
packages/core/src/impl/retryStrategy.ts 100.00% <0.00%> (ø)
packages/core/src/impl/pureJsChunkCombiner.ts 100.00% <0.00%> (ø)
...ges/core/src/impl/completeCommunicationObserver.ts 100.00% <0.00%> (ø)
packages/core/src/query/index.ts

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 258391c...e2982cb. Read the comment docs.

@sranka sranka removed the request for review from bednar April 15, 2020 05:07
@sranka sranka merged commit f34e992 into master Apr 15, 2020
@sranka sranka deleted the sranka/172 branch April 15, 2020 05:09
@sranka sranka added this to the 1.2.0 milestone Apr 15, 2020
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.

Links in doc comments
3 participants