bugGNU Octave - Bugs: bug #52608, quiver/quiver3 marker...

 
 

bug #52608: quiver/quiver3 marker documentation is unclear

Submitted by:  None
Submitted on:  Thu 07 Dec 2017 01:13:48 AM UTC  
 
Category: DocumentationSeverity: 3 - Normal
Priority: 5 - NormalItem Group: Documentation
Status: FixedAssigned to: None
Originator Name: Originator Email: -unavailable-
Open/Closed: ClosedRelease: 4.2.1
Operating System: GNU/Linux

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

(Jump to the original submission Jump to the original submission)

Thu 07 Dec 2017 06:01:26 PM UTC, comment #7:

I tried to make the documentation clearer in this cset: http://hg.savannah.gnu.org/hgweb/octave/rev/6915cc404dba.

In addition, this revealed a bug with processing a linestyle argument, so I fixed that as well in this cset http://hg.savannah.gnu.org/hgweb/octave/rev/b71ba49473f4.

Marking as fixed and closing report.

Rik <rik5>
Project Administrator
Thu 07 Dec 2017 04:38:44 PM UTC, comment #6:

Thanks Markus. Richard Crozier also answered my request for help on the Octave Maintainer's list. Attached is the picture he got. The markers are drawn at the origin of the arrows which is equivalent to saying the "base of the arrowshafts" or "the points defined by X, Y inputs".

(file #42598)

Rik <rik5>
Project Administrator
Thu 07 Dec 2017 08:35:32 AM UTC, comment #5:

I ran the code from comment #2 on Matlab R2016a: It doesn't show arrow heads. Just the red marker at the bases of the vector (first two arguments) and red lines.

Markus M├╝tzel <mmuetzel>
Project Member
Thu 07 Dec 2017 04:22:18 AM UTC, comment #4:

And I have no simple idea how to rephrase the documentation.

Maybe change this sentence
"If a marker is specified then markers at the grid points of the vectors are drawn rather than arrows."
to
"If a marker is specified then additional markers at the grid points of the vectors are drawn."
?

But it also depends on whether the arrowhead should also be drawn in this case.

Anonymous
Thu 07 Dec 2017 03:58:31 AM UTC, comment #3:

Oh, I'm not a native English speaker, so I'm afraid that I could not help to give good documentation.

I do not use Matlab. I only use GNU Octave, which is my favorite software.

Anonymous
Thu 07 Dec 2017 02:25:12 AM UTC, comment #2:

Actually, if you have access to Matlab, could you run this test code

It is not clear from their documentation what happens when there is a marker specified. Does it mean the arrowhead isn't drawn?

Rik <rik5>
Project Administrator
Thu 07 Dec 2017 02:15:36 AM UTC, comment #1:

Maybe the documentation should be clearer. Octave is Matlab-compatible and Matlab says

In other words, the markers SHOULD be at the grid points or origin of the vectors.

Can you think of a could way to rephrase the documentation?

Rik <rik5>
Project Administrator
Thu 07 Dec 2017 01:13:48 AM UTC, original submission:

If no marker is specified, then the arrows are at the head of the vectors. For example,

But if a marker is specified, then the markers are at the tail of the vectors. For example,

The docstring of quiver/quiver3 says that

In this above paragraph, what does "the grid points of the vectors" mean? Does it mean the head or the tail of the vectors?

Anonymous

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

Attached Files
file #42598:  quiver_test.png added by rik5 (9KiB - image/png)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by mmuetzel (Posted a comment)
  • -unavailable- added by rik5 (Posted a comment)
  • -unavailable- added by None (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 7 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Thu 07 Dec 2017 06:01:26 PM UTCrik5StatusConfirmed=>Fixed
      Open/ClosedOpen=>Closed
    Thu 07 Dec 2017 04:38:44 PM UTCrik5Attached File-=>Added quiver_test.png, #42598
    Thu 07 Dec 2017 02:15:36 AM UTCrik5CategoryPlotting=>Documentation
      Item GroupIncorrect Result=>Documentation
      StatusNone=>Confirmed
      Summaryquiver/quiver3 marker at the tail rather than at the head=>quiver/quiver3 marker documentation is unclear

    Back to the top


    Powered by Savane 3.1-cleanup1