Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#19260 closed Uncategorized (fixed)

Tutorial some bits a (little) unclear

Reported by: terwey@… Owned by: nobody
Component: Documentation Version: 1.4
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


In the section Playing with the API ( ) it was unclear to me initially that the editing in the polls/ continues after the Info note. The text that gave it eventually away to me appears AFTER the block of code you are supposed to merge into that file.

Secondly when we are in the interactive shell we are told after a while to request a non-existing ID. This will throw an error and that's also stated. However I find it odd that every command has a comment above it except this one. This is odd and could be confusing to some why it throws an error in the first place.

Change History (4)

comment:1 Changed 4 years ago by anonymous

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

This text:
"# Now request an ID that doesn't yet exist, this will throw an error."
Could work :) Forgot to add.

comment:2 Changed 4 years ago by timo

Do you have a suggestion for the first issue? I'm having trouble understanding the problem exactly.

Happy to add the comment as suggested for #2.

comment:3 Changed 4 years ago by Tim Graham <timograham@…>

  • Resolution set to fixed
  • Status changed from new to closed

In a72b8a224721775b31e2075c99165f1e3ca28092:

Fixed #19260 - Added a comment to tutorial 1.

Thanks terwey for the suggestion.

comment:4 Changed 4 years ago by Tim Graham <timograham@…>

In 897d8adb1c1938261472de39ccd8066b3aacf8df:

[1.5.X] Fixed #19260 - Added a comment to tutorial 1.

Thanks terwey for the suggestion.

Backport of a72b8a2247 from master

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