obsidian-plugin-docs difference between getBasePath, getFullPath, getRealPath, getFullReal…

…Path

Feb 22 '22 15:02 ooker777

Hey! Thanks for helping out!

Unfortunately, the API reference docs are automatically generated from https://github.com/obsidianmd/obsidian-api, so any changes will be overwritten the next time we update the docs.

Ideally we merge this upstreams in the obsidian-api repository, or we find a better place to document this.

Feb 23 '22 13:02 marcusolsson

Hey @ooker777! I've gone ahead and added a copy of the .d.ts file to this repository. Could you move the documentation to obsidian.d.ts, and I'll regenerate the docs in a subsequent commit?

Mar 10 '22 10:03 marcusolsson

So your strategy is to store user-submitted documentation in that file? I'm not sure what will you do next when the official .d.ts file changes?

Is #41 correct?

Mar 10 '22 10:03 ooker777

Fortunately, it should be relatively easy to handle conflicts, since the most of the changes will be additions and can be fast-forwarded on top of the upstream changes. It'll be like maintaining a fork. In the event where the Obsidian team makes changes to the user-submitted docs, I'll handle the conflicts case by case.

Yes, #41 looks great! 👍

Mar 10 '22 10:03 marcusolsson