bugGNU Octave - Bugs: bug #65167, Graphic object property docs need...

 
 

bug #65167: Graphic object property docs need to be updated for numerous property changes

Submitter:  Nicholas Jankowski <nrjank>
Submitted:  Mon 15 Jan 2024 10:25:28 PM UTC
   
 
Category:  Documentation Severity:  2 - Minor
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Open/Closed:  * Closed
Release:  * stable Operating System:  * Any
Fixed Release:  9.1.0 Planned Release:  9.1.0
* Mandatory Fields

Add a New Comment Rich Markup
   

Jump to the original submission

Sun 28 Jan 2024 06:36:02 AM UTC, comment #18: 

Pushed an update to stable at
https://hg.savannah.gnu.org/hgweb/octave/rev/29f23c6668b2

that adds property definitions for all of the uixx objects.  This should address all of the Graphics Property pages.  At least, all of the properties currently attached to any graphics objects have definitions or are marked unused/unimplemented.  Did my best to verify property behavior before marking as unimplemented, etc. Going to mark this as fixed and close the report, but if i missed something or someone sees a glaring error, please let me know.

Nicholas Jankowski <nrjank>
Group Member
Thu 18 Jan 2024 10:16:03 PM UTC, comment #17: 

@nrjank: On a related note, you have a patch at https://savannah.gnu.org/bugs/index.php?57138 which might be worth applying.  I haven't reviewed, and it might no longer be necessary.

Rik <rik5>
Group administrator
Wed 17 Jan 2024 02:51:08 AM UTC, comment #16: 

Thanks! Builds clean for me too now.

Dmitri.
--

Dmitri A. Sergatskov <dasergatskov>
Wed 17 Jan 2024 02:38:12 AM UTC, comment #15: 
Nicholas Jankowski <nrjank>
Group Member
Wed 17 Jan 2024 01:44:47 AM UTC, comment #14: 

I usually just delete doc/ (in the build directory) and then type make.

Dmitri.
--

Dmitri A. Sergatskov <dasergatskov>
Wed 17 Jan 2024 01:42:21 AM UTC, comment #13: 

yes, just caught that too. missing bracket in text/unit. rebuilding and make check to make sure nothing else then I'll repush.

there's not a quick make shortcut just to build docs is there?

Nicholas Jankowski <nrjank>
Group Member
Wed 17 Jan 2024 01:13:33 AM UTC, comment #12: 

And now:

doc/interpreter/plot-textproperties.texi:256: @w missing closing brace
doc/interpreter/plot-textproperties.texi:256: @ref missing closing brace
doc/interpreter/plot-textproperties.texi:256: @w missing closing brace
doc/interpreter/plot-textproperties.texi:256: @ref missing closing brace


Dmitri.
--

Dmitri A. Sergatskov <dasergatskov>
Wed 17 Jan 2024 12:43:11 AM UTC, comment #11: 

will review. missed testing 'surface'.

Nicholas Jankowski <nrjank>
Group Member
Wed 17 Jan 2024 12:19:28 AM UTC, comment #10: 

Not sure if this is the change that broke it:

make[2]: Entering directory '/home/dima/src/octave/gcc_gopt'
rm -f doc/interpreter/plot-surfaceproperties.texi-t doc/interpreter/plot-surfaceproperties.texi && /bin/sh run-octave -disable-asan --norc --silent --no-history --path ../doc/interpreter --eval "genpropdoc ('surface');" > doc/interpreter/plot-surfaceproperties.texi-t && mv doc/interpreter/plot-surfaceproperties.texi-t doc/interpreter/plot-surfaceproperties.texi

(lt-octave-gui:1260936): Gtk-WARNING **: 19:18:52.025: Theme parsing error: <data>:1:0: Expected a valid selector
error: number of columns must match
error: called from
    genpropdoc>getdoc at line 1703 column 17
    genpropdoc>getstructure at line 2494 column 9
    genpropdoc at line 53 column 9
make[2]: *** [Makefile:31879: doc/interpreter/plot-surfaceproperties.texi] Error 1
make[2]: Leaving directory '/home/dima/src/octave/gcc_gopt'
make[1]: *** [Makefile:28210: all-recursive] Error 1
make[1]: Leaving directory '/home/dima/src/octave/gcc_gopt'
make: *** [Makefile:11387: all] Error 2


See also buildbots

Dmitri.
--

Dmitri A. Sergatskov <dasergatskov>
Tue 16 Jan 2024 11:46:01 PM UTC, comment #9: 

pushed another set as
https://hg.savannah.gnu.org/hgweb/octave/rev/e5694f558ad9

for text, image, and surface objects

Nicholas Jankowski <nrjank>
Group Member
Tue 16 Jan 2024 09:17:37 PM UTC, comment #8: 

'make check' runs the m-file "test/fntests.m".  I verified that it is only looking for BIST tests in liboctave/, libinterp/, and scripts/.  Go ahead and remove the BIST tests in genpropdoc.m when you push any further changes.

Rik <rik5>
Group administrator
Tue 16 Jan 2024 08:23:54 PM UTC, comment #7: 

thanks for the cleanup. i should have a few more ready today.  will try to tighten up some of it before pushing.

regarding the BIST:  I ran a make check with and without those lines and i didn't see a change to the numbers of m files tested/number without tests.  I could do it again with a known fail in there to be sure, but I'm guessing it isn't run.

Nicholas Jankowski <nrjank>
Group Member
Tue 16 Jan 2024 07:53:57 PM UTC, comment #6: 

I checked in some minor improvements to your patch.  See https://hg.savannah.gnu.org/hgweb/octave/rev/13404200b381.

This is looking good.  Whatever we get into release 9.1 is bonus at this point.

Rik <rik5>
Group administrator
Tue 16 Jan 2024 04:04:28 AM UTC, comment #5: 

not yet.  other graphics objects on the to-do list:

Legend Line Text Image Patch Scatter Surface Light Uimenu Uibuttongroup Uicontextmenu Uipanel Uicontrol Uitable Uitoolbar Uipushtool Uitoggletool


if more get done for 9, great, if not they can work into the next minor release.

Nicholas Jankowski <nrjank>
Group Member
Tue 16 Jan 2024 01:24:42 AM UTC, comment #4: 

Is this bug ready to close now?

Rik <rik5>
Group administrator
Tue 16 Jan 2024 01:18:03 AM UTC, comment #3: 

pushed https://hg.savannah.gnu.org/hgweb/octave/rev/e5c8be39987d

to stable.  updates all properties listed in the root/figure/axes columns of the spreadsheet that weren't already defined.  Tested and verified as many of them as i could. i didn't review all of the already defined ones to verify that their behavior still matches what's written.

Nicholas Jankowski <nrjank>
Group Member
Mon 15 Jan 2024 10:47:56 PM UTC, comment #2: 

(edit) could someone more familiar with the legend object itself check that list and verify if it shouldn't have any of the 'base' properties, etc.

Nicholas Jankowski <nrjank>
Group Member
Mon 15 Jan 2024 10:46:41 PM UTC, comment #1: 

attached is a spreadsheet with the current state of properties for all of the graphics object types. first patch for root/figure/axes will try to provide definitions for any that say 'no definition' as well as check the state of those marked unused / unimplemented.

one item of concern is the Legend column.  I realize for us a Legend is just another axes handle, but there are a lot of properties that seem like they should be present for legend that are not (creating a legend then diving down to the legend handle and going a get shows a lot of properties not listed on that page ,including most of the 'base' properties.). is genpropdoc generating the legend list correctly? if someone more familiar with the object itself?

(file #55575)

Nicholas Jankowski <nrjank>
Group Member
Mon 15 Jan 2024 10:25:28 PM UTC, original submission:  

As initially noted over in bug #64985 a number of graphics object property changes have occurred but haven't been captured in the documentation (within genpropdoc.m). Creating this report as a placeholder for tracking updates to correct that. Once i have a build number and verify the docs still build without error, the first patch here will address base, root, figure, and axes properties.

Nicholas Jankowski <nrjank>
Group Member

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #55575:  graphic_props_list.ods added by nrjank (10KiB - application/vnd.oasis.opendocument.spreadsheet - property document state for v8.4.0)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by dasergatskov (Posted a comment)
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by nrjank (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 4 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2024-01-28 nrjank StatusIn Progress Fixed
        Open/ClosedOpen Closed
        Fixed ReleaseNone 9.1.0
    2024-01-15 nrjank Attached File- Added graphic_props_list.ods, #55575

    Back to the top

    Powered by Savane 3.13-02a9.
    Corresponding source code