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

docs: add support for getters (and setters) on class #833

Closed
vintheweirdass opened this issue Nov 15, 2024 · 3 comments
Closed

docs: add support for getters (and setters) on class #833

vintheweirdass opened this issue Nov 15, 2024 · 3 comments
Labels
docs gen Related to the documentation generation

Comments

@vintheweirdass
Copy link

vintheweirdass commented Nov 15, 2024

On our package https://jsr.io/@dunno/jsr-registry-bindings (specifically on the main file https://github.com/teamdunno/jsr-registry-bindings/blob/main/mod.ts#L155), the getters that I coded here
image
doesn't get displayed on the docs, only shows the private variables that I used for the getters
image
But on vscode (or any other ide), the getters showed up
image
image
image

@github-project-automation github-project-automation bot moved this to Needs Triage in JSR Nov 15, 2024
@vintheweirdass vintheweirdass changed the title docs: add support for getters (or setters) for class docs: add support for getters (or setters) on class Nov 15, 2024
@vintheweirdass vintheweirdass changed the title docs: add support for getters (or setters) on class docs: add support for getters (and setters) on class Nov 15, 2024
@lucacasonato
Copy link
Member

I can see the getter as an readonly property here: https://jsr.io/@dunno/jsr-registry-bindings/doc/~/Package#accessor_firstfetch

This page however lists the getter as a method: https://jsr.io/@dunno/jsr-registry-bindings/doc/~/Package.prototype.firstFetch. This is a bug, and is tracked here: denoland/deno_doc#666

@lucacasonato lucacasonato added bug docs gen Related to the documentation generation labels Nov 22, 2024
@lucacasonato lucacasonato moved this from Needs Triage to Ready in JSR Nov 22, 2024
@vintheweirdass
Copy link
Author

Alright thanks! Im going to close this issue for now

@vintheweirdass
Copy link
Author

(For future readers) The bug is being tracked here => denoland/deno_doc#666

@vintheweirdass vintheweirdass closed this as not planned Won't fix, can't repro, duplicate, stale Nov 23, 2024
@github-project-automation github-project-automation bot moved this from Ready to Done in JSR Nov 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs gen Related to the documentation generation
Projects
Status: Done
Development

No branches or pull requests

2 participants