Skip to content
New issue

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

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

Already on GitHub? # to your account

Update DOC.md Troubleshooting section #981

Merged
merged 1 commit into from
Aug 18, 2023
Merged

Update DOC.md Troubleshooting section #981

merged 1 commit into from
Aug 18, 2023

Conversation

kylefhartzenberg
Copy link
Contributor

@kylefhartzenberg kylefhartzenberg commented Aug 15, 2023

Pull request addresses #979 by adding an explanation regarding the behaviour of snippet expansion when multiple snippets can potentially expand at the current buffer-position.

The explanation was appended to the Troubleshooting section of the documentation given that snippet priority is already discussed prior, and the intent is to make users aware of potentially "unexpected" behaviour when reordering snippets that share similar triggers.

@L3MON4D3
Copy link
Owner

Ah, nice!
The existing troubleshooting-section is specific to the loaders, I don't think general advice like priority should be in there.

Could you instead create a toplevel-section on troubleshooting, move the content from loaders/troubleshooting to troubleshooting/adding snippets/loaders and put the new advice into its own subsection, troubleshooting/adding snippets/general? I'm not set on the structure, if you think something else makes more sense, go ahead :D

@kylefhartzenberg
Copy link
Contributor Author

That makes sense. I thought the same but I didn't want to interfere with the existing structure. The requested changes have been made. Let me know if you'd like anything else updated/edited.

@L3MON4D3
Copy link
Owner

Good instinct :D
I'm happy with the content, could you move the section between Config-Options and Api?
And then squash all commits into just one?

Added an explanation regarding the behaviour of snippet expansion when multiple snippets can potentially expand at the current buffer-position. Re-structured DOC.md to separate Troubleshooting advice into its own section.
@kylefhartzenberg
Copy link
Contributor Author

Done and done. Also, added a link at the bottom of the original Snippet-specific filetypes section to reference relevant sub-section that's now in Troubleshooting.

@L3MON4D3
Copy link
Owner

Beautiful, thank you very much!

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

Successfully merging this pull request may close these issues.

2 participants