🐛 Fix markdown formatting in --help output

[gar1t]

Includes fix to typo in function name.

Ref: #447

[svlandeg]

Update: I've solicited feedback from Tiangolo on PR #964 to first establish what the ideal output is for a variety of use-cases. This will help us better understand the changes proposed in this PR as well.

I know that some of these edits may seem straightforward, but as I was writing the additional unit tests it became clear to me that there are a lot of different edge cases and interdependencies of the code paths, so I think it's important to get this all straight first.

I will get back to this PR once we've decided on the other one. Thanks for your patience! 🙏

[lamehost]

Hello,

I am writing a Typer based application for which i need fairly elaborated command help messages. I am impacted by the problem described at #447 and i am looking for a solution. I don't mean to be pushy, but i am looking for the best thing to do and i wonder if i shall simply go through the monkey patch suggested on the issue or if i should wait for this to be merged. Is there any plan to incorporate the new code any time soon?

Thank you

Regards

[svlandeg]

Hi @lamehost, apologies with the delay on this! We're currently finishing up #964 and then I'll get back to this one.

[svlandeg]

This PR should now be ready to merge. The unit tests were already merged into master with PR #964. The fix in this PR further allows us to remove an xfail from two of those tests. The markdown formatting of the help text should now be much better - fixing the issue #447.

[CJKay]

Can we expect this to release at any point in the near future? This bug currently renders some usage documentation totally unreadable (pun intended). 🙂

[svlandeg]

Yes, we intend to merge & release this soonish, after Tiangolo has been able to give it a last check! (no need to ping him, he's aware).

[tiangolo]

Awesome, thank you! 🚀 And thanks for the patience with this. ☕

Thanks @svlandeg for all the help! 🙌

This will be available in Typer 0.17.1 in the next few hours. 🎉