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

Documentation display is broken #28

Open
LaurentTreguier opened this issue Mar 2, 2017 · 0 comments
Open

Documentation display is broken #28

LaurentTreguier opened this issue Mar 2, 2017 · 0 comments
Assignees

Comments

@LaurentTreguier
Copy link
Collaborator

LaurentTreguier commented Mar 2, 2017

Currently, documentation is not always displayed properly.
Some characters used in markdown are not escaped. For example, any * pair will be interpreted by VSCode and the text in between the two * will be shown in italic.
Some parts of the documentation use a $(UL something) syntax that are only translated to `something`, when it should be something else entirely (here with UL it should be a list with some LI elements inside).
Furthermore, something like $(UL text (parens) other text) will be replaced by the simple regex with `text (parens` other text) because it stops at the first closing parenthesis.

Long story short, the parsing done for documentation should be a lot more complex than it currently is (a couple of regex replacements and separation of text and code examples).

@LaurentTreguier LaurentTreguier self-assigned this Mar 7, 2017
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

No branches or pull requests

1 participant