Following instructions in the manual and the result is different with the image in the example #99959

New Issue

Hoang Duy Tran · 2022-07-25T09:54:47+02:00

Hoang Duy Tran commented

2022-07-25 09:54:47 +02:00

System Information
Operating system: macOS-10.15.7-x86_64-i386-64bit 64 Bits

Blender Version
Broken: version: 3.3.0 Alpha, branch: master, commit date: 2022-07-14 22:44, hash: blender/blender@0e9367fc29

Addon Information
Name: Precision Drawing Tools (PDT) (1, 5, 2)
Author: @clockmender, @ermo

Short description of error
Followed instruction in the manual at this page

Worked Example - Building A Book Scanner

and at after the instruction in this part:

Extrude new vertex -0.04 in Z:

Set Cartesian Coordinates to 0,0,-0.04 respectively, set operation to Extrude Vertices and click Delta.

OR Key vd,,0.04 into Command Line.

You should now have this:

I got this image instead:

which is completely different from the image in the example:

https:*docs.blender.org/manual/en/dev/_images/addons_pdt_scan_3.png

Can whoever written the documentation please verify if they are getting the same result as referenced in the documentation? I'm expecting to have the SAME as result documented.

Exact steps for others to reproduce the error

**System Information** Operating system: macOS-10.15.7-x86_64-i386-64bit 64 Bits **Blender Version** Broken: version: 3.3.0 Alpha, branch: master, commit date: 2022-07-14 22:44, hash: `blender/blender@0e9367fc29` **Addon Information** Name: Precision Drawing Tools (PDT) (1, 5, 2) Author: @clockmender, @ermo **Short description of error** Followed instruction in the manual at this page [Worked Example - Building A Book Scanner ](https://docs.blender.org/manual/en/dev/addons/3d_view/precision_drawing_tools/book_scanner.html) and at after the instruction in this part: ``` Extrude new vertex -0.04 in Z: Set Cartesian Coordinates to 0,0,-0.04 respectively, set operation to Extrude Vertices and click Delta. OR Key vd,,0.04 into Command Line. You should now have this: ``` I got this image instead: ![Screenshot 2022-07-25 at 08.43.35.png](https://archive.blender.org/developer/F13314551/Screenshot_2022-07-25_at_08.43.35.png) which is completely different from the image in the example: [https:*docs.blender.org/manual/en/dev/_images/addons_pdt_scan_3.png ](https:*docs.blender.org/manual/en/dev/_images/addons_pdt_scan_3.png) Can whoever written the documentation please verify if they are getting the same result as referenced in the documentation? I'm expecting to have the SAME as result documented. **Exact steps for others to reproduce the error** -

Hoang Duy Tran commented

2022-07-25 09:54:47 +02:00

Added subscriber: @hoanguk

Germano Cavalcante commented

2022-07-25 23:58:16 +02:00

Added subscribers: @clockmender, @ermo

Alan Odom commented

2022-07-26 17:04:56 +02:00

The line in the manual:

Or Key vd,,0.04

Should read:

Or Key vd,,-0.04

Can some one with authority update that page please.

It works as intended with the cartesian coordinates set and using "Delta" button.

The line in the manual: **Or Key vd,,0.04** Should read: **Or Key vd,,-0.04** Can some one with authority update that page please. It works as intended with the cartesian coordinates set and using "Delta" button.

Germano Cavalcante commented

2022-07-26 17:24:11 +02:00

Changed status from 'Needs Triage' to: 'Confirmed'

blender-admin commented

2022-07-26 17:29:06 +02:00

This issue was referenced by blender/documentation@9433

Germano Cavalcante commented

2022-07-26 17:29:25 +02:00

Changed status from 'Confirmed' to: 'Resolved'

Germano Cavalcante closed this issue

2022-07-26 17:29:25 +02:00

Germano Cavalcante self-assigned this 2022-07-26 17:29:25 +02:00

Hoang Duy Tran commented

2022-07-27 14:54:16 +02:00

In the process recreating this example, the book scanner, I have found a little error in this section:

Copy leftmost of the new vertices 0,0.65,0.14:

Set Cartesian Coordinates to 0,0.65,0.14 respectively, set operation to Duplicate Geometry and click Delta.
OR Key dd,0.65,0.14 into Command Line.

the value

0,0.65,0.14 should be read as 0,0.065,0.14, the middle value should have an extra leading 0 (ie. divide by 10 more) and should be read as 0.065 and not 0.65 as documented
This leading to the whole command line should be changed from dd,0.65,0.14 to dd0,0.065,0.14

Please alter the documentation.

In the process recreating this example, the book scanner, I have found a little error in this section: ``` Copy leftmost of the new vertices 0,0.65,0.14: Set Cartesian Coordinates to 0,0.65,0.14 respectively, set operation to Duplicate Geometry and click Delta. OR Key dd,0.65,0.14 into Command Line. ``` the value - **0,0.65,0.14** should be read as **0,0.065,0.14**, the middle value should have an extra leading **0** (ie. divide by 10 more) and should be read as **0.065** and not **0.65** as documented - This leading to the whole command line should be changed from **dd,0.65,0.14** to **dd0,0.065,0.14** Please alter the documentation.

Alan Odom commented

2022-07-27 15:34:47 +02:00

We need to alter the part that says:

Set Cartesian Coordinates to 0,0,65,0.14 to 0,0,065,0.14 as well....

And this of course:

This leading to the whole command line should be changed from dd,0.65,0.14 todd0,0.065,0.14

Can someone with authority to do this please make the changes, I do not have write authority here....

Thanks.

We need to alter the part that says: **Set Cartesian Coordinates to 0,0,65,0.14** to **0,0,065,0.14** as well.... And this of course: This leading to the whole command line should be changed from **dd,0.65,0.14** to**dd0,0.065,0.14** Can someone with authority to do this please make the changes, I do not have write authority here.... Thanks.

Germano Cavalcante commented

2022-07-27 15:49:36 +02:00

Good to see details in the manual being fixed.
Could you be more clear on all the necessary changes?
Note that it is recommended to create a patch showing these changes.
The manual SVN repository can be checkout through the link at https://developer.blender.org/diffusion/BM/

If I'm not mistaken, the file to be changed is:
{https://developer.blender.org/diffusion/BM/browse/trunk/blender_docs/manual/addons/3d_view/precision_drawing_tools/book_scanner.rst}

Good to see details in the manual being fixed. Could you be more clear on all the necessary changes? Note that it is recommended to create a patch showing these changes. The manual SVN repository can be checkout through the link at https://developer.blender.org/diffusion/BM/ If I'm not mistaken, the file to be changed is: {https://developer.blender.org/diffusion/BM/browse/trunk/blender_docs/manual/addons/3d_view/precision_drawing_tools/book_scanner.rst}

Alan Odom commented

2022-07-27 15:57:46 +02:00

Yes, that is the correct file, lines 54 and 56 change 0.65 to 0.065, all three instances in those lines.

Thanks!

Yes, that is the correct file, lines 54 and 56 change 0.65 to 0.065, all three instances in those lines. Thanks!

Hoang Duy Tran commented

2022-07-28 09:06:15 +02:00

There is also a little mistake, though not so visible to readers, as they are reading from the HTML text, where the error is NOT so visible, but as a translator, documenter, you will notice this error, as you're running the command printed in the PDT's command line, it will create an error message, the line affecting is:

#: ../../addons/3d_view/precision_drawing_tools/examples.rst:75
msgid "Extrude 30 at 0 degrees – Command **ei30**,"

The value ei30 should include the last comma , as the ending of the command sequence, so it should be written as

msgid "Extrude 30 at 0 degrees – Command **ei30,**"

instead.

Please also check and recapture screen images for PDT section if needed, for 3.3, as their UI has changed significantly. Quite a few button labels had changed.

There is also a little mistake, though not so visible to readers, as they are reading from the HTML text, where the error is NOT so visible, but as a translator, documenter, you will notice this error, as you're running the command printed in the PDT's command line, it will create an error message, the line affecting is: ``` #: ../../addons/3d_view/precision_drawing_tools/examples.rst:75 msgid "Extrude 30 at 0 degrees – Command **ei30**," ``` The value **ei30** should include the last comma ``,`` as the ending of the command sequence, so it should be written as ``` msgid "Extrude 30 at 0 degrees – Command **ei30,**" ``` instead. Please also check and recapture screen images for PDT section if needed, for 3.3, as their UI has changed significantly. Quite a few button labels had changed.

Hoang Duy Tran commented

2022-07-29 07:32:44 +02:00

Just to be pedantic about the keyboard sequence mentioned in this line:

- : ../../addons/3d_view/precision_drawing_tools/book_scanner.rst:142
- : ../../addons/3d_view/precision_drawing_tools/book_scanner.rst:98
msgid "Set 3D Cursor, SHIFT+D, CTRL+M Y - standard Blender commands."

There should be a "Enter" after the "Shift+D" and by the way, these keyboard sequences should be using format like

:kbd:`Shift+D`, :kbd:`Enter`, :kbd:`Ctrl+M`, :kbd:`Y`

There is another instance of 'SHIFT+D' further down the document that needed to be set the same as well.

The reason to mention this is that when I use it myself the first time, I was stumbled for the sequence, after Shift+D I immediately did 'Ctrl+M, Y' and that did not produce anything.

Next, this sequence of action:

#: ../../addons/3d_view/precision_drawing_tools/book_scanner.rst:79
msgid "**OR** Key vd,0.02, into Command Line."

The selected vertex is still the old one, you need to instruct users to select the extruded vertex, or else the next extrude will be wrong.

A note about flakiness of the Redo and Undo. If you make a mistake and undo, this could force you to repeat from the beginning if you do not save the file after every step. I think with per instruction demanding accuracy as this module, each instruction should be saved and undo/redo-able. Try to run through the example and you will see what I meant.

Just to be pedantic about the keyboard sequence mentioned in this line: ``` - : ../../addons/3d_view/precision_drawing_tools/book_scanner.rst:142 - : ../../addons/3d_view/precision_drawing_tools/book_scanner.rst:98 msgid "Set 3D Cursor, SHIFT+D, CTRL+M Y - standard Blender commands." ``` There should be a "Enter" after the "Shift+D" and by the way, these keyboard sequences should be using format like ``` :kbd:`Shift+D`, :kbd:`Enter`, :kbd:`Ctrl+M`, :kbd:`Y` ``` There is another instance of 'SHIFT+D' further down the document that needed to be set the same as well. The reason to mention this is that when I use it myself the first time, I was stumbled for the sequence, after Shift+D I immediately did 'Ctrl+M, Y' and that did not produce anything. Next, this sequence of action: ``` #: ../../addons/3d_view/precision_drawing_tools/book_scanner.rst:79 msgid "**OR** Key vd,0.02, into Command Line." ``` The selected vertex is still the old one, you need to instruct users to select the extruded vertex, or else the next extrude will be wrong. A note about flakiness of the Redo and Undo. If you make a mistake and undo, this could force you to repeat from the beginning if you do not save the file after every step. I think with per instruction demanding accuracy as this module, each instruction should be saved and undo/redo-able. Try to run through the example and you will see what I meant.

Alan Odom commented

2022-07-29 16:09:06 +02:00

The reason to mention this is that when I use it myself the first time, I was stumbled for the sequence, after Shift+D I immediately did 'Ctrl+M, Y' and that did not produce anything.

You can use either Enter, or simply click the mouse button to activate these keyins, I think this should be covered in basic Blender operation, not here.... It is really up to those with authority to decide whether we need be this pedantic in an instruction to use a toolset like PDT. I think users will have a basic understanding of how Blender commands work prior to using this add-on, quite happy to be proven wrong tho....

There should be a "Enter" after the "Shift+D" and by the way, these keyboard sequences should be using format like

:kbd:Shift+D, :kbd:Enter, :kbd:Ctrl+M, :kbd:Y

Where is this mentioned in the guide to producing Blender Documentation please?

A note about flakiness of the Redo and Undo. If you make a mistake and undo, this could force you to repeat from the beginning if you do not save the file after every step.

I do not agree with this comment.

The odd typo is one thing, I was under extreme time pressure to get this manual into Blender Docs at the time. If someone wants to re-write it all, I am happy with that too, but I don't have the authority to update Blender Docs.

Perhaps we should have all your comments, before proceeding with any changes, then agree the changes with @mano-wii before any more updates are undertaken, this piecemeal approach over many days is not efficient IMHO.

> The reason to mention this is that when I use it myself the first time, I was stumbled for the sequence, after Shift+D I immediately did 'Ctrl+M, Y' and that did not produce anything. You can use either Enter, or simply click the mouse button to activate these keyins, I think this should be covered in basic Blender operation, not here.... It is really up to those with authority to decide whether we need be this pedantic in an instruction to use a toolset like PDT. I think users will have a basic understanding of how Blender commands work prior to using this add-on, quite happy to be proven wrong tho.... > There should be a "Enter" after the "Shift+D" and by the way, these keyboard sequences should be using format like > > :kbd:`Shift+D`, :kbd:`Enter`, :kbd:`Ctrl+M`, :kbd:`Y` Where is this mentioned in the guide to producing Blender Documentation please? > A note about flakiness of the Redo and Undo. If you make a mistake and undo, this could force you to repeat from the beginning if you do not save the file after every step. I do not agree with this comment. The odd typo is one thing, I was under extreme time pressure to get this manual into Blender Docs at the time. If someone wants to re-write it all, I am happy with that too, but I don't have the authority to update Blender Docs. Perhaps we should have all your comments, before proceeding with any changes, then agree the changes with @mano-wii before any more updates are undertaken, this piecemeal approach over many days is not efficient IMHO.

Sign in to join this conversation.