GNOME Bugzilla – Bug 739418
Help needs updating
Last modified: 2017-12-05 16:23:03 UTC
In 'Help', 'Strategy 1:', para 4 states: Using notes, enter the missing numbers which are not in that column or 3x3 box, into the the upper field. These numbers are candidate solutions for that cell. The word 'notes' above is highlighted (a link) that when clicked displays a page about how to use 'notes' as follows: Notes Notes, or pencilmarks, can be added to any cell. They allow you to mark possible values for a cell, or store other data that might help you. Notes will store all characters in order, but will remove repetitions of characters. To add notes to a cell: 1. Select the cell 2. Click on the part of a cell that is above the line that appears when you hover over it. Alternatively, type N. 3. Type your notes 4. Press Enter or click outside of the text box. A line does not appear when hovering over the cell and typing 'N' or 'n' has no effect. Therefore, the user cannot enter missing numbers in a cell. The paragraph following the above states: You can also take notes in the bottom of the cell by clicking in the bottom of the cell or by typing M. Clicking in the bottom part of the cell or typing 'M' or 'm' does not work either. OS is Sparkylinux (Debian Jessie) with the Mate (1.8.1) desktop.
We forgot to update the documentation for 3.14. Oops. It's probably going to need more extensive changes than just notes, so I'm going to generalize the title of this bug. Anyway, notes still work, but you have to right-click in the cell now. (Or hold Ctrl and press a digit key.) I'm assigning this bug to myself because I think it's particularly important, but if anyone wants to work on it before I get to it, feel free.
Here's a small bit of related info I saw was out of date in the help: The "Track additions" button that disappeared after 3.12 in the UI of gnome-sudoku is still referenced in multiple strings in the help file.
Created attachment 364964 [details] [review] help: Update Saving/Resuming
Created attachment 364965 [details] [review] help: Remove info on notes from Basics
Created attachment 364967 [details] [review] help: Update Notes
Created attachment 364968 [details] [review] help: Update Highlighter
Created attachment 364969 [details] [review] help: Remove Hints
Created attachment 364970 [details] [review] help: Remove Track Additions
Created attachment 364971 [details] [review] help: Remove Toolbar
Created attachment 364972 [details] [review] help: Remove Command Line
Created attachment 364973 [details] [review] help: Update links in the Get Involved pages
Created attachment 364974 [details] [review] help: Update Keyboard Shortcuts
Created attachment 364975 [details] [review] help: Update Printing current game
Created attachment 364976 [details] [review] help: Update Printing multiple puzzles
Created attachment 364977 [details] [review] help: Remove mention of replaying on the main page
Created attachment 364978 [details] [review] help: Remove Advanced section
Created attachment 364979 [details] [review] help: Minor editorial work
It’s probably still not perfect, but at least it won’t be misleading anymore. Also available at https://git.gnome.org/browse/gnome-sudoku/log/?h=wip/piotrdrag/help-update
Review of attachment 364964 [details] [review]: ::: help/C/save-resume.page @@ +6,3 @@ <link type="guide" xref="index#play"/> + <revision pkgversion="3.26" version="0.2" date="2017-12-05" status="final"/> I believe the docs team would ask you to add a new revision tag for the current release cycle, without touching the original one, and give it status="review". See https://wiki.gnome.org/DocumentationProject/StatusTracking. I think I've broken this rule more than a few times myself. :( I'm (probably) going to mark all the patches as accepted, but please update this in all of them.
Review of attachment 364965 [details] [review]: OK
Review of attachment 364967 [details] [review]: Two changes here, please: * Let's call them "earmarks" (maybe even rename it to earmarks.page) since you can't add arbitrary notes anymore * Please also document the two other ways to add the earmarks: 1) If you hold Ctrl when clicking on a cell, then it will open the notes popover 2) If you right click instead of left clicking on a cell, it will also open the notes popover This being completely undiscoverable, it's no surprise you didn't know... proper documentation will help (at least the few people who bother to read it :)
Review of attachment 364968 [details] [review]: OK
Review of attachment 364969 [details] [review]: Yup.
Review of attachment 364970 [details] [review]: Yup.
Review of attachment 364971 [details] [review]: Deleting things is fun, right?
Review of attachment 364972 [details] [review]: *stamp*
Review of attachment 364973 [details] [review]: ::: help/C/documentation.page @@ +20,3 @@ The <app>GNOME Games</app> documentation is maintained by a volunteer community. You are welcome to participate.</p> +<p>To contribute to the Documentation Project, feel free to get in touch with us using <link href="https://cbe003.chat.mibbit.com/?url=irc%3A%2F%2Firc.gnome.org%2Fdocs">irc</link>, or via our <link href="https://mail.gnome.org/mailman/listinfo/gnome-doc-list">mailing list</link>. Might as well fix the extra space here "Project, feel" while you're at it.
Review of attachment 364974 [details] [review]: I have to write a comment on every patch, or Splinter will crash. Poor Splinter. :(
Review of attachment 364975 [details] [review]: OK
Review of attachment 364976 [details] [review]: OK
Review of attachment 364977 [details] [review]: Yes.
Review of attachment 364978 [details] [review]: Removing features is fun!
Review of attachment 364979 [details] [review]: ::: help/C/strategy.page @@ +33,3 @@ <item><p>Determine which numbers in the row are missing.</p></item> + <item><p>Choose one of the empty cells in this row. Determine which of the missing numbers are in that column or in that 3×3 box.</p></item> + <item><p> Using <link xref="notes">notes</link>, enter the missing numbers which are not in that column or 3×3 box, into the the upper field. These numbers are candidate solutions for that cell.</p></item> Normally I might overlook the extra space here, but not in a patch that's changing x to ×!
Created attachment 364993 [details] [review] help: Update Notes Addressed feedback.
Review of attachment 364993 [details] [review]: ::: help/C/earmarks.page @@ +25,3 @@ + +<title>Earmarks</title> +<p>Earmarks (small numeric notes) can be added to any cell. They allow you to mark possible values for a cell. Earmarks will store all characters in order, but will remove repetitions of characters.</p> I don't like the last sentence here. I would say: "Earmarks allow you to store any number of digits in the cell. Each digit may be selected only once." @@ +36,3 @@ +<p>You can remove a number from the earmarks by pressing <keyseq><key>Ctrl</key><key>1</key></keyseq> through <keyseq><key>Ctrl</key><key>9</key></keyseq> again.</p> + +<note><p>You can also add earmarks by clicking the cell while pressing <key>Ctrl</key> or right-clicking the cell, and then choosing a number.</p></note> Add a comma here: "</key>, or" ::: help/C/keyboard-shortcuts.page @@ +58,3 @@ </tr> <tr> + <td><p>Add a number to the top earmarks of a cell</p></td> Remove "top" since there are no bottom notes anymore. ::: help/Makefile.am @@ +20,3 @@ legal.xml \ license.page \ + earmarks.page \ Alphabetize it!
Comment on attachment 364972 [details] [review] help: Remove Command Line https://git.gnome.org/browse/gnome-sudoku/commit/?id=bdaef6eece6aa90b5c27fcbb3be8239706c89464
Comment on attachment 364969 [details] [review] help: Remove Hints https://git.gnome.org/browse/gnome-sudoku/commit/?id=1cb664130e6e6f68e393c14780498c065e7494b4
Comment on attachment 364965 [details] [review] help: Remove info on notes from Basics https://git.gnome.org/browse/gnome-sudoku/commit/?id=f86e0693daf71508c06401d21ee27c5abd5e7f85
Comment on attachment 364971 [details] [review] help: Remove Toolbar https://git.gnome.org/browse/gnome-sudoku/commit/?id=975974e4e6755cb3f6648b21be719a69d5c1658a
Comment on attachment 364970 [details] [review] help: Remove Track Additions https://git.gnome.org/browse/gnome-sudoku/commit/?id=426d74fef194b3fb7dbda13ae75510a19369756f
Comment on attachment 364968 [details] [review] help: Update Highlighter https://git.gnome.org/browse/gnome-sudoku/commit/?id=d31918edf9aa143d5340d76953d7ee05c28fb7d9
Comment on attachment 364974 [details] [review] help: Update Keyboard Shortcuts https://git.gnome.org/browse/gnome-sudoku/commit/?id=cfd310769ec89cb10a13b1300b4276e5561690a5
Comment on attachment 364973 [details] [review] help: Update links in the Get Involved pages https://git.gnome.org/browse/gnome-sudoku/commit/?id=1e228823fb45179654c34e2053229333e44aa1e5
Comment on attachment 364993 [details] [review] help: Update Notes https://git.gnome.org/browse/gnome-sudoku/commit/?id=419d3ddbe81338ff582c5f204327bbb22df6f4a9
Comment on attachment 364977 [details] [review] help: Remove mention of replaying on the main page https://git.gnome.org/browse/gnome-sudoku/commit/?id=cf9d5800db37ac87c9cb2f17748fe1896a7a0103
Comment on attachment 364978 [details] [review] help: Remove Advanced section I fudged the rebase somewhere, so this is now part of https://git.gnome.org/browse/gnome-sudoku/commit/?id=cf9d5800db37ac87c9cb2f17748fe1896a7a0103
Comment on attachment 364975 [details] [review] help: Update Printing current game https://git.gnome.org/browse/gnome-sudoku/commit/?id=58e8a3f8e58cd7d803047900608387197308dc71
Comment on attachment 364976 [details] [review] help: Update Printing multiple puzzles https://git.gnome.org/browse/gnome-sudoku/commit/?id=c5f28bfd8e865559f867410cff5be385d87328a5
Comment on attachment 364964 [details] [review] help: Update Saving/Resuming https://git.gnome.org/browse/gnome-sudoku/commit/?id=2329afe9f2ffbba6b0b52073cc2c440ad96b789a
Comment on attachment 364979 [details] [review] help: Minor editorial work https://git.gnome.org/browse/gnome-sudoku/commit/?id=1b7c7eb749c79153797022f92306d88aacb7df69
Thank you! :D