Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#17526 closed Cleanup/optimization (fixed)

Grammatical error in djangodocs.py?

Reported by: datakid@… Owned by: nobody
Component: Documentation Version: 1.3
Severity: Normal Keywords: documentation
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

An email thread pointed to this page: https://docs.djangoproject.com/en/1.3/ref/forms/validation/

Which has the leading note: "Changed in Django 1.2: Please, see the release notes"

This is triggered in the code at lines 82-84 in djangodocs.py

From everything I've read, and as an English as a first language background, I think that the comma should be removed:

"Please read the release notes"

I've not added a patch, since I don't have access to an svn co atm to create a diff, and it's a minor change that could be done by anyone.

Minor grammar nazi bug?

Change History (6)

comment:1 Changed 3 years ago by anonymous

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

Of course, when I said it should be removed, I meant it to say

"Please see the release notes"

rather than

"Please read the release notes"

comment:2 Changed 3 years ago by anonymous

You are missing the fact that text is meant to represent speech. When you read the sentence out loud, it is perfectly fine with a short pause after the word please. So when you want to transfer that sentence into text, you need to have a comma in there to indicate that there is the short pause.

So, in my opinion, you are talking about a matter of taste and not about a grammatic rule.

And consider that the pause can be used to add some "emphasis" to what you are trying to say.

I know that many academically qualified language teachers cannot all agree about these kinds of things. It highlights the fact that text is really to represent speech, and people do not speak in the same manner.

comment:3 Changed 3 years ago by anonymous

I disagree on a number of points, but I'm not overly phased - it really is a minor issue. Am happy for this to be closed wont fix, just thought I'd add my bit.

cheers

comment:4 Changed 3 years ago by lukeplant

  • Triage Stage changed from Unreviewed to Accepted
  • UI/UX unset

I agree - whether it is needed grammatically or not, the pause implied by the comma is over the top emphasis to my ears at least, and can come over as rude.

comment:5 Changed 3 years ago by lukeplant

  • Resolution set to fixed
  • Status changed from new to closed

In [17367]:

Fixed #17526 - unnecessary comma in 'Please, see the release notes' removed

Thanks to datakid for the report

comment:6 Changed 3 years ago by anonymous

can come over as rude? Hmmm... then there are a lot of people in the World who are rude every day when they speak. I do not agree with that view. Any way, we, do, agree, that, this, is, a, very, minor, issue. dramatic effect *starts to cry*

Note: See TracTickets for help on using tickets.
Back to Top