#22233 closed Bug (invalid)

Writing your first Django app guide v1.6 code examples missing reference to files

Reported by: colinmcnamara Owned by: nobody
Component: Documentation Version: 1.6
Severity: Normal Keywords: docs, usability, intro
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

I'm going through the intro to Django course with codehatch
I keep getting gummed up in each of the code examples where the files that we are working on changes

Suggestion / improvement (i'm submitting bug so I can submit patches to fix this)
put a figure statement on code examples that reference the path and file name of code example

Not sure if it is a bug, or new feature but I'm filing it as a bug since it stopped me from progressing on the intro tutorial.

doc with comments - that are capturing the challenges discussed
https://docs.google.com/document/d/1F87-qjIbUoWcLrqLnavnJPXYhJuNY46L7HPt1xB_Vlw/edit#

My tech level
Linux sysadmin w/ minimally functional python experience (called DevOps now)
Core reviewer OpenStack Docs

Hope this helps. Looking forward to merging patches

Change History (3)

comment:1 Changed 12 months ago by bmispelon

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

Hi,

Have you looked at the development version of the docs (there's a version switcher on the bottom left of each page)?

In ticket #20910, we added filenames for each example (this was a pretty intrusive change so it wasn't backported to older versions of the docs).
Does that solve your issue or do you think we can further improve on this?

Thanks.

comment:2 Changed 12 months ago by colinmcnamara

Thank you for pointing me to the switcher to trunk. Yes, ticket #20910 resolves this bug. Thank you very much for pointing me to that.
I'll go ahead and close this bug as already resolved.

Regards

--Colin

comment:3 Changed 12 months ago by colinmcnamara

  • Resolution set to invalid
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.
Back to Top