bugGNU Octave - Bugs: bug #57138, Categorize graphics properties for...

 
 

bug #57138: Categorize graphics properties for better doc readability

Submitter:  Pantxo Diribarne <pantxo>
Submitted:  Tue 29 Oct 2019 04:49:14 PM UTC
 
Category:  Documentation Severity:  2 - Minor
Priority:  5 - Normal Item Group:  Documentation
Status:  Patch Submitted Assigned to:  None
Originator Name:  Open/Closed:  * Open
Release:  * dev Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       

 

Wed 10 Nov 2021 09:46:26 PM UTC, comment #3: 

attached is an updated patch against the current default branch. I took the liberty of filling in some categories on new properties.  The updated printdoc function seems ok, the change for categories didn't change much, mainly nesting the main function in another for loop to go through by category. Not too sure how to call/use genpropcod.m, though to test it out.

Also, there are about a dozen properties with no category, as they didn't seem to fit any of the others. they have a ##Uncategorized comment to make it easy for to find and replace them later. I assume they should be defaulted to the Miscellaneous section if I understand the intent correctly.

Small tweaks to this would be easy later, but there are a lot of individual line changes that i suspect would render this patch stale fairly quickly if anyone else makes property changes.   Attached both the updated patch and the modified genpropdoc.m

(file #52234, file #52235)

Nicholas Jankowski <nrjank>
Project Member
Tue 15 Sep 2020 05:47:03 PM UTC, comment #2: 

I think it would be worthwhile doing something like this to make the documentation more useful.
Unfortunately, the patch no longer applies and got incomplete in the meantime.
Could you please rebase the patch on the current default branch?

Markus Mützel <mmuetzel>
Project Member
Tue 29 Oct 2019 04:50:10 PM UTC, comment #1: 

I attached the patch for testing.

(file #47763)

Pantxo Diribarne <pantxo>
Project Member
Tue 29 Oct 2019 04:49:14 PM UTC, original submission:  

When I have a bug number I'll submit a first draft of a patch that aims at putting every grapĥics properties into a category so that the long lists of graphics properties are split into more readable blocks.

Pantxo Diribarne <pantxo>
Project Member

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #52234:  prop_category_v2_bug57138.diff added by nrjank (66KiB - application/octet-stream)
file #52235:  genpropdoc.m added by nrjank (88KiB - text/plain)
file #47763:  prop_category.patch added by pantxo (56KiB - text/x-patch)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by nrjank (Updated the item)
  • -email is unavailable- added by mmuetzel (Posted a comment)
  • -email is unavailable- added by pantxo (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 project members can vote.

     

     

     

     

    Follow 4 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-11-10 nrjank Attached File- Added prop_category_v2_bug57138.diff, #52234
        Attached File- Added genpropdoc.m, #52235
    2019-10-29 pantxo StatusNone Patch Submitted
    2019-10-29 pantxo Attached File- Added prop_category.patch, #47763

    Back to the top


    Powered by Savane 3.9