Skip to content
This repository has been archived by the owner on Aug 24, 2023. It is now read-only.

Docs: Add documentation tags and examples for usage #30

Closed
maschad opened this issue May 3, 2023 · 1 comment · Fixed by #31
Closed

Docs: Add documentation tags and examples for usage #30

maschad opened this issue May 3, 2023 · 1 comment · Fixed by #31
Assignees
@maschad
Labels
released

Comments

@maschad
Copy link
Member

maschad commented May 3, 2023

we should tag methods, classes and interfaces to generate docs to inform consumers about usage.

There is useful information here that isn't in the `@libp2p/prometheus-metrics` docs.

Can you please PR that repo with the information that's been removed here.

You can use the `@packageDocumentation` tag ([example](https://github.com/libp2p/js-libp2p/blob/master/src/pnet/index.ts#L1C1-L23) - [output](https://libp2p.github.io/js-libp2p/modules/pnet.html)) to get general docs to appear on a given page, and the `@example` tag to annotate individual methods, classes or interfaces with code that people can copy/paste to get started.

Originally posted by @achingbrain in libp2p/js-libp2p#1505 (comment)
@maschad maschad mentioned this issue May 3, 2023
Merged
maschad added a commit to maschad/js-libp2p-prometheus-metrics that referenced this issue May 6, 2023
@maschad
docs: added examples for package documentation on API (libp2p#30)
15db4f0
@maschad maschad mentioned this issue May 6, 2023
Merged
achingbrain pushed a commit that referenced this issue May 9, 2023
@maschad
docs: added examples for package documentation for methods (#31)
7dbd895 
Closes #30
github-actions bot pushed a commit that referenced this issue May 12, 2023
@semantic-release-bot
chore(release): 1.1.4 [skip ci]
aa1d14b 
## [1.1.4](v1.1.3...v1.1.4) (2023-05-12)

### Trivial Changes

* Update .github/workflows/semantic-pull-request.yml [skip ci] ([7756331](7756331))
* Update .github/workflows/semantic-pull-request.yml [skip ci] ([1a3861f](1a3861f))
* Update .github/workflows/semantic-pull-request.yml [skip ci] ([b66c4a0](b66c4a0))

### Documentation

* added examples for package documentation for methods ([#31](#31)) ([7dbd895](7dbd895)), closes [#30](#30)
@github-actions
Copy link

🎉 This issue has been resolved in version 1.1.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@maschad maschad

Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: added examples for package documentation for methods maschad/js-libp2p-prometheus-metrics
1 participant
@maschad