Skip Menu |
 

This queue is for tickets about the CPAN-Changes CPAN distribution.

Report information
The Basics
Id: 72894
Status: open
Priority: 0/
Queue: CPAN-Changes

People
Owner: Nobody in particular
Requestors: perl [...] toby.ink
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: (no value)
Fixed in: (no value)



Subject: Release titles / comments
Download (untitled) / with headers
text/plain 841b
Some software projects give titles to releases. (Debian and Ubuntu spring to mind, though neither of those are currently distributed on CPAN!) And sometimes it is useful to include a comment in a change log which is not technically a change. e.g. 0.82 2011-11-10 # This is the last planned release before major API changes in 0.9x. - add foo feature - remove bar feature So my suggestion is this... the spec should allow comments to be placed within the Changes file, which could simply be skipped over by the parser. All lines that match /^\s*#/ are comments; and additionally trailing comments can be added to version lines like this: 0.90_00 2011-11-21 # New API - Preview I Comments are not allowed in other places - e.g.: - add foo feature # this is not a comment. it's still part of the change line
Ticket 69321 is related
On Fri Dec 02 13:01:46 2011, TOBYINK wrote: Show quoted text
> Some software projects give titles to releases. (Debian and Ubuntu > spring to mind, though neither of those are currently distributed on > CPAN!) > > And sometimes it is useful to include a comment in a change log which > is not technically a change. e.g. > > 0.82 2011-11-10 > # This is the last planned release before major API changes in 0.9x. > - add foo feature > - remove bar feature > > So my suggestion is this... the spec should allow comments to be placed > within the Changes file, which could simply be skipped over by the > parser. > > All lines that match /^\s*#/ are comments; and additionally trailing > comments can be added to version lines like this: > > 0.90_00 2011-11-21 # New API - Preview I > > Comments are not allowed in other places - e.g.: > > - add foo feature # this is not a comment. it's still part of the > change line
These seem like useful things to display somewhere like metacpan, so having them not parsed at all doesn't seem very useful.


This service is sponsored and maintained by Best Practical Solutions and runs on Perl.org infrastructure.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.