Links for README.org + increase timeout for load_sync #782
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In nvim-orgmode, you can point to a headline either by using the star syntax (* HEADLINE) or by using a custom-id in the properties drawer of the headline, and then refer to it using the hash syntax (#custom-id). This commit adds custom_ids for all the headlines referred to into the README.org file and fixes relative links to other files in the repository.
kristijanhusak
requested changes
Jul 24, 2024
On slow devices (for example Android smartphones using Termux), loading a lot of org files takes more than 5 seconds, which will make the default timeout for the promise to expire, leaving the plugin in a semi-loaded state where some functionalities may not work, forcing the user to reload the plugin multiple times hoping that the system has something already cached and it will take less than 5 seconds.
SlayerOfTheBad
pushed a commit
to SlayerOfTheBad/orgmode
that referenced
this pull request
Aug 16, 2024
* docs(README): add custom_ids and fix relative links In nvim-orgmode, you can point to a headline either by using the star syntax (* HEADLINE) or by using a custom-id in the properties drawer of the headline, and then refer to it using the hash syntax (#custom-id). This commit adds custom_ids for all the headlines referred to into the README.org file and fixes relative links to other files in the repository. * fix(init): increment the default timeout to 15 seconds On slow devices (for example Android smartphones using Termux), loading a lot of org files takes more than 5 seconds, which will make the default timeout for the promise to expire, leaving the plugin in a semi-loaded state where some functionalities may not work, forcing the user to reload the plugin multiple times hoping that the system has something already cached and it will take less than 5 seconds.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello, this branch contains two commits:
the first one fixes the links on the top of the README.org file, creating custom_ids for all the needed headlines and using the
file:notation for other files in the repository, thus making it easier to navigate the file while in Neovim;the second one increments the timeout of the promise for the
load_syncmethod ofOrgFilesto 15 seconds. I know it might sound a lot, but on very slow devices (for example my Android phone, where I use orgmode and org-roam a lot) loading my > 100 files takes slightly more than 5 seconds, and sometimes it fails and I am therefore forced to:Lazy reloadover and over again, until the caching of the OS is good and it loads in less than 5 seconds. I thought about having this timeout configurable or dynamic depending on the platform, but I am not sure the effort is worth. In the end, on PC you should not even see the difference.. tell me if you want me to do things differently, I'll be more than happy to modify the code!Edit: I am not sure why the
luarocksstep is failing, there might be an issue with the dependencies? I don't think it is related to my changes though!