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

Correct vim modeline in ChangeLog #3450

Merged
merged 2 commits into from
Dec 29, 2024

Conversation

softins
Copy link
Member

@softins softins commented Dec 27, 2024

Short description of changes

Update the vim modeline in ChangeLog to fix vim error and enable syntax highlighting

CHANGELOG: 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:

$ vim ChangeLog
"ChangeLog" 2056L, 73367B
Error detected while processing modelines:
line 2056:
E518: Unknown option: -->
Press ENTER or type command to continue

It is because the closing comment tag --> is interpreted by vim as a command. In addition, the syntax=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

  • I've verified that this Pull Request follows the general code principles
  • I tested my code and it does what I want
  • My code follows the style guide
  • I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
  • I've filled all the content above

Copy link
Member

@ann0see ann0see left a 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.

@ann0see ann0see added this to the Release 3.12.0 milestone Dec 28, 2024
@softins softins requested a review from pljones December 28, 2024 23:27
ChangeLog Outdated
@@ -2053,4 +2053,4 @@

- initial version

<!-- vim: syntax=Markdown -->
<!-- vim: syntax=Markdown: set ft=markdown: -->
Copy link
Collaborator

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?

Copy link
Collaborator

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.)

Copy link
Member Author

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.)

Good idea. Though I'll do that separately from this bug fix.

Copy link
Member Author

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.)

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

@ann0see ann0see merged commit 4af2b5b into jamulussoftware:main Dec 29, 2024
12 checks passed
@softins softins deleted the fix-changelog-vim-modeline branch December 30, 2024 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants