[Octave-bug-tracker] [bug #60313] Move docstrings to dedicated single pages

[Pantxo Diribarne]

URL:
  <https://savannah.gnu.org/bugs/?60313>

                 Summary: Move docstrings to dedicated single pages 
                 Project: GNU Octave
            Submitted by: pantxo
            Submitted on: mar. 30 mars 2021 20:23:12 UTC
                Category: Documentation
                Severity: 1 - Wish
                Priority: 5 - Normal
              Item Group: Feature Request
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
                 Release: dev
         Discussion Lock: Any
        Operating System: Any

    _______________________________________________________

Details:

Currently, dosctrings for Octave functions are scattered all around in the
chapters of the manual, interlaced or not with explanatory text. This
structure if often hard to read.

As proposed during the latest on-line meeting, I attached a test patch in
which I moved all docstrings to a dedicated "Function Reference" appendix. A
link, with the first help sentence is added where @DOCSTRING originally was. 

I also attached the script I used to do the job automatically.



    _______________________________________________________

File Attachments:


-------------------------------------------------------
Date: mar. 30 mars 2021 20:23:12 UTC  Name: move_docstrings.patch  Size:
352kio   By: pantxo

<http://savannah.gnu.org/bugs/download.php?file_id=51164>
-------------------------------------------------------
Date: mar. 30 mars 2021 20:23:12 UTC  Name: move_docstrings.m  Size: 4kio  
By: pantxo

<http://savannah.gnu.org/bugs/download.php?file_id=51165>

    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?60313>

_______________________________________________
  Message posté via Savannah
  https://savannah.gnu.org/