HTML Comments are irrelevant in embedded Issues and PR and basically just push out the actual content when someone forgets to remove them.
This adds format_desc, which is called on every embedded github description, so you can add formatting later on if needed.
I also noticed you already did this in one function, but you used sub, which - if i read the docs correctly - only removes the first instance. hence i am using subn
HTML Comments are irrelevant in embedded Issues and PR and basically just push out the actual content when someone forgets to remove them.
This adds format_desc, which is called on every embedded github description, so you can add formatting later on if needed.
I also noticed you already did this in one function, but you used
sub
, which - if i read the docs correctly - only removes the first instance. hence i am usingsubn
I too moved shortening into format_desc