Re: [Django] #15396: full path to modules in documentation inconsistently referenced

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+
 Reporter:  slinkp@…   |Owner:  (none)
 Type:  Bug|   Status:  new
Component:  Documentation  |  Version:  dev
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+
Changes (by Ülgen Sarıkavak):

 * cc: Ülgen Sarıkavak (added)

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/0107018e5066a482-e17e5295-29a3-4de7-b4a3-7339dc6fd046-00%40eu-central-1.amazonses.com.

Re: [Django] #15396: full path to modules in documentation inconsistently referenced

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+
 Reporter:  slinkp@…   |Owner:  Akshat verma
 Type:  Bug|   Status:  assigned
Component:  Documentation  |  Version:  dev
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+
Changes (by Akshat verma):

 * owner:  (none) => Akshat verma
 * status:  new => assigned


Comment:

 Try adding add_module_names = False in conf.py

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/01070187454ecf73-f8d2744a-31dd-4284-bb4e-2ce48734bfd5-00%40eu-central-1.amazonses.com.

Re: [Django] #15396: full path to modules in documentation inconsistently referenced

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+
 Reporter:  slinkp@…   |Owner:  (none)
 Type:  Bug|   Status:  new
Component:  Documentation  |  Version:  dev
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+
Changes (by Mariusz Felisiak):

 * owner:  Mar Sánchez => (none)
 * status:  assigned => new


-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/074.e1b7f6a162d7d90f30d4594c7c9e20ff%40djangoproject.com.

Re: [Django] #15396: full path to modules in documentation inconsistently referenced

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+---
 Reporter:  slinkp@…   |Owner:  Mar Sánchez
 Type:  Bug|   Status:  assigned
Component:  Documentation  |  Version:  master
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+---

Comment (by Mariusz Felisiak ):

 In [changeset:"f5f4c28bfcf5b1303689ed8d854d5e0d9cfb14ea" f5f4c28b]:
 {{{
 #!CommitTicketReference repository=""
 revision="f5f4c28bfcf5b1303689ed8d854d5e0d9cfb14ea"
 [2.2.x] Refs #15396 -- Mentioned full path to GZipMiddleware in
 documentation.

 Backport of f1d4a540b29c6766b988852bc302ac036a2d82e2 from master
 }}}

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/074.756a4cf44ed203af06965ac6a9edfb8f%40djangoproject.com.

Re: [Django] #15396: full path to modules in documentation inconsistently referenced

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+---
 Reporter:  slinkp@…   |Owner:  Mar Sánchez
 Type:  Bug|   Status:  assigned
Component:  Documentation  |  Version:  master
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+---

Comment (by Mariusz Felisiak ):

 In [changeset:"9fa6c737df0cbdc23702b849b793e7f3eb067b3e" 9fa6c737]:
 {{{
 #!CommitTicketReference repository=""
 revision="9fa6c737df0cbdc23702b849b793e7f3eb067b3e"
 [3.0.x] Refs #15396 -- Mentioned full path to GZipMiddleware in
 documentation.

 Backport of f1d4a540b29c6766b988852bc302ac036a2d82e2 from master
 }}}

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/074.d8b49778a66b647851234b2a82a360c0%40djangoproject.com.

Re: [Django] #15396: full path to modules in documentation inconsistently referenced

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+---
 Reporter:  slinkp@…   |Owner:  Mar Sánchez
 Type:  Bug|   Status:  assigned
Component:  Documentation  |  Version:  master
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+---

Comment (by Mariusz Felisiak ):

 In [changeset:"f1d4a540b29c6766b988852bc302ac036a2d82e2" f1d4a540]:
 {{{
 #!CommitTicketReference repository=""
 revision="f1d4a540b29c6766b988852bc302ac036a2d82e2"
 Refs #15396 -- Mentioned full path to GZipMiddleware in documentation.
 }}}

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/074.2082cdc6588153e3710f98fa77119698%40djangoproject.com.

Re: [Django] #15396: full path to modules in documentation inconsistently referenced

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+
 Reporter:  slinkp@…   |Owner:  mayela
 Type:  Bug|   Status:  assigned
Component:  Documentation  |  Version:  master
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+
Changes (by mayela):

 * owner:  nobody => mayela
 * status:  new => assigned


Comment:

 I just added a little note about adding the full path of the class in the
 settings file

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/074.fb3f552cd94893ddb0b01aef06eb03bc%40djangoproject.com.

Re: [Django] #15396: full path to modules in documentation inconsistently referenced

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+
 Reporter:  slinkp@…   |Owner:  nobody
 Type:  Bug|   Status:  new
Component:  Documentation  |  Version:  master
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+

Comment (by timgraham):

 One option to display the full module path is something like this:
 {{{
 #!diff
 diff --git a/docs/ref/models/expressions.txt
 b/docs/ref/models/expressions.txt
 index f74c4f2..d0b4a14 100644
 --- a/docs/ref/models/expressions.txt
 +++ b/docs/ref/models/expressions.txt
 @@ -360,7 +360,8 @@ output value.
  ``ExpressionWrapper()`` expressions
  ---

 -.. class:: ExpressionWrapper(expression, output_field)
 +.. class:: django.db.models.ExpressionWrapper(expression, output_field)
 +:module:

  .. versionadded:: 1.8

 }}}

--
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/074.b303794678b05cd6cea68ee30b29eb6d%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #15396: full path to modules in documentation inconsistently referenced

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+
 Reporter:  slinkp@…   |Owner:  nobody
 Type:  Bug|   Status:  new
Component:  Documentation  |  Version:  master
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+

Comment (by denis_g@…):

 It would be very nice to have this option somehow available, but disabled
 by default if you think it's not good to enable it for all.

 For instance, full resource path may be rendered with the `display: none`
 style, so people who need it may enable it with the simple CSS rule.

 Or there may be some kind of JavaScript magic, which would display the
 full resource path on user click or hover, or whatever else.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/074.196250017437b30ee01323ce327ee887%40djangoproject.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #15396: full path to modules in documentation inconsistently referenced

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+
 Reporter:  slinkp@…   |Owner:  nobody
 Type:  Bug|   Status:  new
Component:  Documentation  |  Version:  master
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+

Comment (by EvilDMP):

 I agree that simply turning on display of modules with `add_module_names`
 would be a rather scattershot approach. Module names are not always
 provided anyway.

 I think that the best approach would be for code samples to include
 imports, or at least the first one of a batch of them.

 Similarly, if an object's path is not clear from its reasonably immediate
 context, then it should be spelled out in full the first time it's
 introduced in its reference documentation.

 If there's a list of objects all from the same module, the module can be
 mentioned once at the top of the list.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/074.795b53195a8b09beecf2e30eef20065b%40djangoproject.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #15396: full path to modules in documentation inconsistently referenced

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+
 Reporter:  slinkp@…   |Owner:  nobody
 Type:  Bug|   Status:  new
Component:  Documentation  |  Version:  master
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+

Comment (by davesque):

 From duplicate #19864, I had thought about Carl's suggestion that the
 heading should instead state the full resource path instead of just the
 resource name:

 'class'' django.template.response.TemplateResponse'''
 instead of
 'class'' TemplateResponse'''

 I wasn't sure if that would sometimes be too verbose.  That's why I had
 suggested the alternative:

 module: {{{django.template.response}}}
 'class'' TemplateResponse''

 However, I prefer Carl's suggestion if it doesn't disrupt the layout of
 the current docs too much.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #15396: full path to modules in documentation inconsistently referenced

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+
 Reporter:  slinkp@…   |Owner:  nobody
 Type:  Bug|   Status:  new
Component:  Documentation  |  Version:  master
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+

Comment (by aaugustin):

 #19864 was another duplicate.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [Django] #15396: full path to modules in documentation inconsistently referenced (was: full path to GzipMiddleware undocumented)

[Django]

#15396: full path to modules in documentation inconsistently referenced
---+
 Reporter:  slinkp@…   |Owner:  nobody
 Type:  Bug|   Status:  new
Component:  Documentation  |  Version:  master
 Severity:  Normal |   Resolution:
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+
Changes (by ptone):

 * version:   => master


Comment:

 #19281 was a dupe for the more general sense, so I've updated the summary
 to be a bit more generic.

 This has always something that has bugged me - and has been somewhere on
 my todo list since this tweet crossed my path:

 https://twitter.com/doughellmann/statuses/248093601886765056 :
 "Python Dev Pro-tip: Include the import statements in each example in your
 documentation. Your casual readers will thank you."

 So there are two places to add this information:

 As information or heading in the reference documentation - and in code
 listings.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.