obsidian-developer-docs icon indicating copy to clipboard operation
obsidian-developer-docs copied to clipboard

Some `@link` tags seem to be removed by the API documenter

Open canova opened this issue 2 years ago • 2 comments

Hi, I was looking at the developer documentation and found some deprecated APIs. For example, see the Workspace.activeLeaf property.

It has a warning like this:

Warning: This API is now obsolete.

That makes sense, so my next step was to find out what to use instead. But reading the documentation, it says this:

The recommended alternatives are: - If you need information about the current view, use . - If you need to open a new file or navigate a view, use .

It looks like there were maybe some inline codes or links that were ommited. Paragraph looks like had some information but maybe they were removed by the generator? I can't find the recommended alternatives in this page.

I believe this page is not the only one with this issue. I also came across splitActiveLeaf with missing alternative information.

canova avatar Oct 16 '23 11:10 canova

I found the raw API documentation for activeLeaf property here: https://github.com/obsidianmd/obsidian-developer-docs/blob/5ca01f620a3ec040ec19e09d1943b27d471c60e5/config/obsidian.d.ts#L4017-L4027

It looks like some of the @link tags are being removed.

canova avatar Oct 16 '23 11:10 canova

Some instances are fixed now. For the others I'll have to use some trickery, as support for @label is not implemented yet in api-extractor. (which we need because we have multiple functions with the same name, but different parameters.)

joethei avatar Oct 17 '23 18:10 joethei