Skip to content

Julia Support#731

Merged
jdkato merged 4 commits intovale-cli:v2from
kellertuer:kellertuer/add-julia
Dec 6, 2023
Merged

Julia Support#731
jdkato merged 4 commits intovale-cli:v2from
kellertuer:kellertuer/add-julia

Conversation

@kellertuer
Copy link
Copy Markdown
Contributor

This PR aims to add Julia support (resolves #729).

I would like to also try to resolve #728 if possible. I added a test file, but I am unsure how to accomplish the string part.
I am also not sure whether my code is correct, since I have never programmed in Go before nor did I have the time to install that, so I just tried to mimic what was there.

For the doc strings, see https://docs.julialang.org/en/v1/manual/documentation/ , maybe it is really just enough to consider strings and multiline strings as text.

The only caveats there are

  • "$(a) and $a" is a string where the current value of a is interpolated twice (placed in there
  • inline math in Julia flavoured Markdown is done with two backticks like raw"``\frac{1}{2}``", where the keyword raw is just used so that I do not have to escape the backslash.

(but maybe the two backpacks can be added to some ignore in the .vale.ini like other Markdown inline math ones as well)

Thanks for writing such a nice package, I already use it on a Julia Package (Markdown) Documentation I am writing.

@kellertuer
Copy link
Copy Markdown
Contributor Author

kellertuer commented Nov 18, 2023

I read a bit about regexpses and looked at the Python example. The current code now tries to include (doc) strings – I added a bit of comments, since for the beginning block I am not sure that works as intended. I put all cases now also in the example file, which. still has to be added to the tests – I have not yet understood how to do that, especially not which output to expect, since I was not yet able to set vale up locally from source..

@jdkato
Copy link
Copy Markdown
Member

jdkato commented Nov 23, 2023

Thanks -- setting up an example file is a big help. I can add the tests and then this should be ready for the next release.

@kellertuer
Copy link
Copy Markdown
Contributor Author

Great, if you need help with the file or understanding something on how Julia is formatted usually, let me know.

@jdkato jdkato merged commit baebd27 into vale-cli:v2 Dec 6, 2023
@jdkato
Copy link
Copy Markdown
Member

jdkato commented Dec 6, 2023

This should be working in the latest release. Let me know if you run into any issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Julia support

2 participants