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

Add inline comments #967

Merged
merged 1 commit into from
Aug 1, 2020
Merged

Conversation

chipsenkbeil
Copy link
Member

@chipsenkbeil chipsenkbeil commented Aug 1, 2020

Resolves #965.

Details

Support comments that are inline and/or multiline versus being at the start of a line.

= My Wiki =

%% Line comment
- Item 1
- Item 2 %%+ Inline comment +%%
- Item 3
%%+ some comment
that continues
on multiple lines +%%

Status

  • Add rxMultilineComment syntax for default vimwiki (markdown and mediawiki are empty)
    • Syntax test for comments (single-line & multiline) added to vimwiki/test/syntax.vader and passing
  • Add multiline comment parsing in s:parse_line of vimwiki/autoload/vimwiki/html.vim
    • Comment parsing test for comments (single-line & multiline) added to vimwiki/test/convert_default_html.vader and passing
  • Update changelog to reflect new PR Add inline comments #967

@tinmarino
Copy link
Member

Pretty good ! Thanks for the tests
Announce when your dev is finished so that we can press the merge button.

@chipsenkbeil chipsenkbeil marked this pull request as ready for review August 1, 2020 21:03
@chipsenkbeil
Copy link
Member Author

chipsenkbeil commented Aug 1, 2020

@tinmarino, ready for review and merge when ready.

  • Fixed a bug or two with what I wrote originally (caught by tests).
  • Was able to revert the change to rxComment with zero impact to this feature.
  • Added syntax and html tests that are passing.

@tinmarino
Copy link
Member

Wonderfull !
Very nice contribution, thank you.

If you have time, maybe you can get a glimpse at multiline highlighting there: #847
For your the API with your plugin, I'd be glad to help, so feel free to create a separete issue in time.

See you.

@tinmarino
Copy link
Member

+1 for the explicative comments
+1 for the self made tests (its hard but for me too :)

@tinmarino tinmarino merged commit 6dff2c6 into vimwiki:dev Aug 1, 2020
@tinmarino tinmarino added default syntax Problems having to do with the default VimWiki syntax syntax Related to syntax and highlighting HTML conversion labels Aug 1, 2020
@chipsenkbeil chipsenkbeil deleted the AddInlineComments branch August 1, 2020 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
default syntax Problems having to do with the default VimWiki syntax HTML conversion syntax Related to syntax and highlighting
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants