-
Notifications
You must be signed in to change notification settings - Fork 1
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
Minor bugfixes #1
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.
LGTM 👍
…locks and {noformat} blocks
bb0e632
to
f57a723
Compare
}); | ||
|
||
// TODO: Fix the code so this test can be unskipped | ||
it.skip('does not apply bold formatting without an asterisk pair at the start of the phrase', function () { |
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.
As this PR fixes minor issue, why do you skip this test - was it existing issue?
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.
Yes, it was an existing issue. See the Note in the PR description.
Description
This PR aims to fix some minor bugs in the Jira to markdown library.
The primary issue addressed in this PR (and the reason for creating this fork) is the issue of intra-word formatting when Jira-flavoured markdown is converted into regular markdown.
Before Fix
phrase_with_underscores
in Jira markdown is transformed tophrase*with*underscores
in regular markdown. This would then be rendered so:This is not desirable behaviour, particularly for important content such as urls and emails.
In the other direction,
phrase*with*asterisks
in regular markdown becomesphrase_with_asterisks
in Jira markdown, which is rendered so:This is also undesirable.
After fix
This library should recognise the
*
and_
characters within words should not be transformed.Other Changes:
Note
There are two skipped test. My markdown expertise has so far proved insufficient for getting this case to pass. (When a snippet like
a**phrase**
is converted from md to jira it will be formatted toa*phrase*
.) I think this is acceptable bug to leave for now for two reasons:If someone can think of a fix or has a use case that suggests this really needs to be fixed please let me know.
References