bitprophet / releases

A powerful Sphinx changelog-generating extension.
http://releases.readthedocs.io/
BSD 2-Clause "Simplified" License
176 stars 41 forks source link

Generate no links by setting ticket number to 0 #10

Closed keimlink closed 10 years ago

keimlink commented 11 years ago

This is a new approach to solve the problem with changelog entries having no issue. It is an updated version of @hynek's pull request #1. I know you were not happy about the hack. So why do I create an updated pull request?

If this pull request looks like a good solution for you, you can reject my other pull request #3 because this solution totally fits my needs.

bitprophet commented 10 years ago

Yea, I think here I do have to bow to pragmatism and use this shorthand, because yup - using directives would be cleaner, but significantly more verbose due to ReST semantics (e.g. all dat whitespace in between everything) and the tersity of this approach is one of its major benefits.

I tested out your change and it seems to work fine (barring other, known issues such as #9) and it is cleaner than #1's implementation :) Thanks!

bitprophet commented 10 years ago

Something struck me this morning - we don't have to use numbers at all for this, could use something even more obviously non-issue-numeric like a dash (-). E.g.:

* :bug:`-` Blah blah

Will experiment with this briefly to see how it looks, but I like the idea of making these non-issue-related "issues" even more distinct. cc @keimlink @hynek

keimlink commented 10 years ago

Sounds like a good idea!

bitprophet commented 10 years ago

Ended up just letting either suffice :) so now a dash OR a zero may be used, up to the user. Could probably just expand further to be "any non numeric value, or a zero" but meh, effort.