Ticket #1409 (closed patch: fixed)

Opened 5 years ago

Last modified 5 years ago

Copyedit + Fixes to submissions.pod

Reported by: Aninhumer Owned by: jkeenan
Priority: normal Milestone:
Component: docs Version: 1.9.0
Severity: medium Keywords:
Cc: Language:
Patch status: applied Platform:

Description

-Various formatting edits

-Separated creation and submission of patches.

-Added "attach to existing ticket if it exists".

-Updated "What Happens Next?", changed references to old bug tickets system to refer to Trac.

New "unresolved patches" link is currently massive, could an admin create a report for this?

Attachments

submissions.pod.patch Download (4.2 KB) - added by Aninhumer 5 years ago.
Changes to submissions.pod

Change History

Changed 5 years ago by Aninhumer

Changes to submissions.pod

  Changed 5 years ago by Aninhumer

Whoops, missed the "New Patches" report, changed patch to include that. Disregard last line of description.

follow-up: ↓ 3   Changed 5 years ago by jkeenan

  • summary changed from [PATCH] Copyedit + Fixes to submissions.pod to Copyedit + Fixes to submissions.pod
  • patch set to new

Most of this patch is unobjectionable, but there are two points where I disagree:

* Most of the time I think =item * is preferable to =item 1. The documentation changes over time. The number and order of bulleted items changes as well. I hate having to renumber when numbers weren't absolutely necessary in the first place.

* I do not agree with this addition:

, and prefix it with a C<[PATCH]> identifier

and, indeed, I think the current statement should be deleted entirely:

Prefix it with a C<[PATCH]> identifier.

When we used RT as our issue tracking system, [PATCH] at the beginning of the subject line was automatically converted to a Patch status. Trac, for better or worse, changes this to the Patch status drop-down box in the lower right-center part of the page. You can select among new, applied, rejected and obsolete. Trac users can then search for these patch statuses. (Right now I will change this TT's status to new. :-) )

Typing [PATCH] on the subject line doesn't add to the searchability of our ticket library and it takes up valuable screenspace that could be used for more descriptive Summary lines. (So I'm going to delete it from the Summary line of this TT.)

I'm not rejecting the rest of the changes. Let's get some more comments.

Thanks for your submission.

kid51

in reply to: ↑ 2 ; follow-up: ↓ 4   Changed 5 years ago by jkeenan

  • owner set to jkeenan
  • status changed from new to assigned

Replying to jkeenan:

* I do not agree with this addition:

, and prefix it with a C<[PATCH]> identifier

and, indeed, I think the current statement should be deleted entirely:

Prefix it with a C<[PATCH]> identifier.

I edited the file just now to do what I advised. Rest of patch is still open for discussion.

Thank you very much.

kid51

in reply to: ↑ 3   Changed 5 years ago by jkeenan

Replying to jkeenan:

I edited the file just now to do what I advised. Rest of patch is still open for discussion.

I should have added: That was in r43460.

  Changed 5 years ago by Aninhumer

With regards to the list format, I was just keeping the existing style, so if the consensus is to change that, I have no objection. (Although it surprises me somewhat that perlpod doesn't have some kind of auto numbering)

And definitely if prefixing [PATCH] is no longer expected then that should be deleted.

  Changed 5 years ago by jkeenan

  • patch changed from new to applied

Remaining items committed to trunk (with small modifications) in r43522.

Will keep ticket open until the weekend to record any complaints or comments.

Thank you very much.

kid51

  Changed 5 years ago by jkeenan

  • status changed from assigned to closed
  • resolution set to fixed

No complaints received; closing ticket.

Note: See TracTickets for help on using tickets.