-
Notifications
You must be signed in to change notification settings - Fork 227
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
Correct vim modeline in ChangeLog #3450
Correct vim modeline in ChangeLog #3450
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can confirm that it works. Thanks.
ChangeLog
Outdated
@@ -2053,4 +2053,4 @@ | |||
|
|||
- initial version | |||
|
|||
<!-- vim: syntax=Markdown --> | |||
<!-- vim: syntax=Markdown: set ft=markdown: --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe use the full form of the setting - filetype
- rather than an abbreviation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Could do with filetype=cfg
in Jamulus.pro
, too.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Could do with
filetype=cfg
inJamulus.pro
, too.)
Good idea. Though I'll do that separately from this bug fix.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Could do with
filetype=cfg
inJamulus.pro
, too.)
cfg
is an ok generic filetype for Jamulus.pro
, but better is to install the syntax and filetype detect files from https://github.com/artoj/qmake-syntax-vim
Short description of changes
Update the vim modeline in
ChangeLog
to fix vim error and enable syntax highlightingCHANGELOG: SKIP
Context: Fixes an issue?
The vim modeline that was added to
ChangeLog
in #2899 is enough to make Github render the file as Markdown, but it results in vim errors when editing the file:It is because the closing comment tag
-->
is interpreted by vim as a command. In addition, thesyntax=Markdown
does not turn on syntax highlighting within vim. For that,set ft=markdown:
is needed, and the trailing:
prevents the-->
from being interpreted by vim.Does this change need documentation? What needs to be documented and how?
Status of this Pull Request
Ready to merge
What is missing until this pull request can be merged?
Nothing
Checklist