Opened 5 hours ago
Last modified 75 minutes ago
#36999 assigned Cleanup/optimization
Reference to Ruby on Rails in Tutorial Part 2 — at Version 1
| Reported by: | Sid R | Owned by: | |
|---|---|---|---|
| Component: | Documentation | Version: | 6.0 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Unreviewed | |
| Has patch: | no | 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?