Opened 7 years ago

Closed 7 years ago

#7482 closed (fixed)

Wording in model documentation

Reported by: cbmeeks <cbmeeks@…> Owned by:
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

URL: http://www.djangoproject.com/documentation/model-api/

Under the Relationships (Many-to-one relationships), look for the ForeignKey optional arguments. The first optional argument (edit_inline) contains a description that reads: "If not False, this related object is edited..."

I've seen "If not False" in documentation before but to me, it reminds me of "if not not true". Would "If True, this related object is edited..." sound/read better?

Sorry if I'm just splitting hairs here.

Change History (5)

comment:1 follow-up: Changed 7 years ago by julien

  • Needs documentation unset
  • Needs tests unset
  • Owner changed from nobody to julien
  • Patch needs improvement unset
  • Status changed from new to assigned

That's a good point. Can you send a patch to make it easier for committers to check it in?

comment:2 in reply to: ↑ 1 ; follow-up: Changed 7 years ago by cbmeeks <cbmeeks@…>

Replying to julien:

That's a good point. Can you send a patch to make it easier for committers to check it in?

I would love to. How do I submit a patch? I see the "Has patch" check box but is that the right one?

Thanks

comment:3 in reply to: ↑ 2 Changed 7 years ago by cbmeeks <cbmeeks@…>

Replying to cbmeeks <cbmeeks@gmail.com>:

Replying to julien:

That's a good point. Can you send a patch to make it easier for committers to check it in?

I would love to. How do I submit a patch? I see the "Has patch" check box but is that the right one?

Thanks

OK, I've signed up and created an account. Looks like creating a patch is more than just a simple click. That's cool. In fact, I would love to get involved. I don't believe this is high priority but if someone wanted to close it then I wouldn't be upset.

Also, once I learn how to submit patches and learn the ticket system, hopefully I can start helping on the smaller fixes and work my way up to real code fixes.

Thanks all!

cbmeeks

comment:4 Changed 7 years ago by julien

  • Owner julien deleted
  • Status changed from assigned to new
  • Triage Stage changed from Unreviewed to Accepted

Have a look at the Django doc about contributing. Also, look up on google how to make patches for SVN, there's plenty of help there.

comment:5 Changed 7 years ago by adrian

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

(In [7757]) Fixed #7482 -- Fixed an awkward wording in docs/model-api.txt. Thanks, cbmeeks <cbmeeks@…>

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