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

💡 implement link titles in the JIRARenderer (contrib) #161

Merged
merged 2 commits into from
Oct 29, 2022
Merged

💡 implement link titles in the JIRARenderer (contrib) #161

merged 2 commits into from
Oct 29, 2022

Conversation

franferrax
Copy link
Contributor

Sample Markdown:

Sample: [inner](https://target "title")

In Linux, test with:

mistletoe -r contrib.jira_renderer.JIRARenderer <(echo 'Sample: [inner](https://target "title")')

Jira result, before this PR changes:

Sample: [inner|https://target]

Jira result, after this PR changes:

Sample: [inner|https://target|title]

Copy link
Collaborator

@pbodnar pbodnar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@franferrax, great, thanks for your contribution.

Do I see it right, that while this works, it doesn't seem to be documented (or anywhere else) by Atlassian?

Next, do you think you could also add a unit test to cover this new feature? I think cloning and extending the existing test_render_link() as test_render_link_with_title() could be sufficient. :)

contrib/jira_renderer.py Show resolved Hide resolved
@franferrax
Copy link
Contributor Author

@franferrax, great, thanks for your contribution.

Do I see it right, that while this works, it doesn't seem to be documented (or anywhere else) by Atlassian?

Oh you are right! I know that documentation, I just discovered this by accident and hadn't realized this isn't there. Feel free to discard this PR if you prefer to only implement well documented features.

Next, do you think you could also add a unit test to cover this new feature? I think cloning and extending the existing test_render_link() as test_render_link_with_title() could be sufficient. :)

Yes, I'll try to do that in a separated commit.

@franferrax
Copy link
Contributor Author

@pbodnar: this PR is now ready for re-review, I've amended and force-pushed 369a5f5d0cb67e to include commented suggestions. I've added test_render_link_with_title(), checked it is passing, and temporarily removed my changes to check it fails.

@pbodnar
Copy link
Collaborator

pbodnar commented Sep 15, 2022

@franferrax, thanks for having quickly implemented the requested changes. :)

@franferrax, great, thanks for your contribution.
Do I see it right, that while this works, it doesn't seem to be documented (or anywhere else) by Atlassian?

Oh you are right! I know that documentation, I just discovered this by accident and hadn't realized this isn't there. Feel free to discard this PR if you prefer to only implement well documented features.

I tried to Google again and I still couldn't find anything on this Jira markup feature, like since which version of Jira it is available. Yet, I think this PR makes sense and it is probably safe to be merged.

So only just for sure, for the case someone follows us, I would leave it still open for a while (like a week or two), giving them a chance to challenge this change. :))

contrib/jira_renderer.py Show resolved Hide resolved
@pbodnar pbodnar merged commit 808abf4 into miyuchina:master Oct 29, 2022
@pbodnar pbodnar mentioned this pull request Jan 7, 2023
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.

2 participants