#36999 closed Cleanup/optimization (fixed)
Reference to Ruby on Rails in Tutorial 2 is unclear
| Reported by: | Sid R | Owned by: | Vinay Datta |
|---|---|---|---|
| Component: | Documentation | Version: | 6.0 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description (last modified by )
This is a minor nitpick, but I found the little blurb about the way Ruby on Rails does migrations a little confusing.
The section in question is https://docs.djangoproject.com/en/6.0/intro/tutorial02/#creating-models and the text in question is:
This includes the migrations - unlike in Ruby On Rails, for example, migrations are entirely derived from your models file, and are essentially a history that Django can roll through to update your database schema to match your current models."
The 'unlike in Ruby on Rails' is not descriptive enough for a person not knowledgeable in Ruby on Rails to understand what the difference is, or why it might matter.
I now wonder if it's simply unimportant, and not necessary to have in the documentation - i.e. just remove 'unlike in Ruby on Rails, for example', and it's just as useful/helpful?
Change History (11)
comment:1 by , 4 weeks ago
| Description: | modified (diff) |
|---|
comment:2 by , 4 weeks ago
comment:3 by , 4 weeks ago
| Owner: | set to |
|---|---|
| Status: | new → assigned |
comment:4 by , 4 weeks ago
| Owner: | removed |
|---|---|
| Status: | assigned → new |
comment:6 by , 4 weeks ago
| Summary: | Reference to Ruby on Rails in Tutorial Part 2 → Reference to Ruby on Rails in Tutorial 2 is unclear |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
The text dates to the introduction of migrations in 2013: 0b3c8fc85168bac7327e7c4372e92b52575547e9. I agree the mention could be removed, or the differing behavior of Ruby on Rails clearly stated.
comment:7 by , 4 weeks ago
Hi, I’ve implemented a fix for this issue and opened a PR:
https://github.com/django/django/pull/20974#issue-4122932021
The change ensures that when Feed.link is missing, an ImproperlyConfigured exception is raised instead of an AttributeError, with handling for both attribute and callable cases.
Please let me know if any changes are needed.
comment:8 by , 4 weeks ago
| Has patch: | set |
|---|---|
| Owner: | set to |
| Patch needs improvement: | set |
| Status: | new → assigned |
comment:9 by , 4 weeks ago
| Patch needs improvement: | unset |
|---|---|
| Triage Stage: | Accepted → Ready for checkin |
I would like to work on this.