LivePreviewState naming collision

[mnaoumov]

There are two pages

1. https://github.com/obsidianmd/obsidian-developer-docs/blob/cc385fedfa8ba84a8909c71850b26b1b4e277616/en/Reference/TypeScript%20API/LivePreviewState.md
2. https://github.com/obsidianmd/obsidian-developer-docs/blob/cc385fedfa8ba84a8909c71850b26b1b4e277616/en/Reference/TypeScript%20API/livePreviewState.md

that differ only in casing.

This is going to be an issue on case-insensitive file systems.

[lishid]

Yeah that one has been annoying. I will find a better name for the interface.

[revolter]

Just stumbled upon this issue, and was confused not being able to do some rebases.

[revolter]

Did you find a better name? I could try to create a PR if I know what name to use.

[joethei]

We haven't found a better name yet, and we can't accept PR's to the relevant docs, as they are generated from our source code.

[mnaoumov]

@joethei How about livePreviewStatePlugin ?

[revolter]

We haven't found a better name yet, and we can't accept PR's to the relevant docs, as they are generated from our source code.

I know. I was asking in order to create a PR for https://github.com/obsidianmd/obsidian-api.

[mnaoumov]

@revolter they don't accept PRs there either. It's all generated

[revolter]

Oooh, I see.

[lishid]

We can't rename the plugin name unfortunately because plugins are already using it. However we can change the type name and that 1) won't break existing plugins, and 2) will most likely not cause plugin build issues if the plugin is simply using the object. It is only a problem if a plugin explicitly specifies a variable of the return value, which is in most cases unnecessary.

I am considering updating it to LPState or LivePreviewStateType.

[mnaoumov]

@lishid you could consider instead of renaming the type, just modify the docs generator to generate unambiguous doc file name such as LivePreviewState2.md

[lishid]

The docs generator is unfortunately a gigantic monstrosity that I dare not attempt to try to modify. :)

[mnaoumov]

That's a pity as it has some serious flaws that you would need to address sooner or later anyways. I try to raise those flaws here and in the forum when I discover them

[revolter]

Any updates after ~2 months?

[lishid]

Fixed by obsidianmd/obsidian-api@165ccdd