Skip to content
This repository was archived by the owner on Jun 14, 2023. It is now read-only.

difference between getBasePath, getFullPath, getRealPath, getFullReal… - #28

Open
ooker777 wants to merge 1 commit into
marcusolsson:mainfrom
ooker777:patch-5
Open

difference between getBasePath, getFullPath, getRealPath, getFullReal…#28
ooker777 wants to merge 1 commit into
marcusolsson:mainfrom
ooker777:patch-5

Conversation

@ooker777

Copy link
Copy Markdown
Contributor

…Path

@marcusolsson

Copy link
Copy Markdown
Owner

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.

@marcusolsson

Copy link
Copy Markdown
Owner

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?

@ooker777

ooker777 commented Mar 10, 2022

Copy link
Copy Markdown
Contributor Author

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?

@marcusolsson

Copy link
Copy Markdown
Owner

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! 👍

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants