Opened 2 months ago

Closed 2 months ago

Last modified 2 months ago

#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 Sid R)

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 Sid R, 2 months ago

Description: modified (diff)

comment:2 by Vidhi Singh, 2 months ago

I would like to work on this.

comment:3 by Vidhi Singh, 2 months ago

Owner: set to Vidhi Singh
Status: newassigned

comment:4 by Vidhi Singh, 2 months ago

Owner: Vidhi Singh removed
Status: assignednew

comment:5 by Sushmita Yadav, 2 months ago

Hi, I would like to work on this issue. Is it available?

comment:6 by Tim Graham, 2 months ago

Summary: Reference to Ruby on Rails in Tutorial Part 2Reference to Ruby on Rails in Tutorial 2 is unclear
Triage Stage: UnreviewedAccepted

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 Vinay Datta, 2 months 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 Jacob Walls, 2 months ago

Has patch: set
Owner: set to Vinay Datta
Patch needs improvement: set
Status: newassigned

comment:9 by Jacob Walls, 2 months ago

Patch needs improvement: unset
Triage Stage: AcceptedReady for checkin

comment:10 by GitHub <noreply@…>, 2 months ago

Resolution: fixed
Status: assignedclosed

In f3bdfd2:

Fixed #36999 -- Removed mention of Ruby on Rails from tutorial part 2.

This comparison wasn't fleshed out, so it was distracting.

comment:11 by Jacob Walls <jacobtylerwalls@…>, 2 months ago

In b8cb57fe:

[6.0.x] Fixed #36999 -- Removed mention of Ruby on Rails from tutorial part 2.

This comparison wasn't fleshed out, so it was distracting.
Backport of f3bdfd2065373272ebb637785cea2313582a8b8c from main.

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