Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

About explanation for sourcePath #76

Open
RyotaUshio opened this issue Oct 17, 2023 · 0 comments
Open

About explanation for sourcePath #76

RyotaUshio opened this issue Oct 17, 2023 · 0 comments

Comments

@RyotaUshio
Copy link

RyotaUshio commented Oct 17, 2023

The sourcePath:string parameter appears in several places in the API, but is sometimes not explained at all. Even when it is explained, the explanation varies from place to place and was not always easy to understand when I started writing plugins. Also, I have seen some plugins using sourcePath incorrectly.

So far, the clearest explanation that I could find is the one given in FileManager.generateMarkdownLink:

https://docs.obsidian.md/Reference/TypeScript+API/FileManager/generateMarkdownLink

where the link is stored in, used to compute relative links.

Hopefully this explanation will be adopted everywhere. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant