denoland / denoland/deno_doc

Documentation should take class extensions into consideration

Open
#136 9 comments 5 reactions 0 assignees View on GitHub
request
Dominant language
Rust
Stars
297
Forks
73
Avg merge
5h 20m
Merged PRs (30d)
18

Description

As of right now, `deno doc` does not respect extensions. This means

```
export class B {
public id: number;
}
```

```
export class A extends B {
public userName: string;
}
```
if I run `deno doc` for class `A`, it will only document the property `userName` but **will not** for `id` part of the class extension.

`deno doc` should be able to read this, and respect the extensions of extensions (example, B extends C)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by running `deno doc` on the A and B class examples in the issue and inspect the documentation generator entry point that handles class members. Done means class A documents its own `userName` property, inherited `id`, and members inherited through further extensions such as B extending C.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust, typescript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.