bugGNU Octave - Bugs: bug #57844, COPYRIGHT.md file is not (a...

 
 

bug #57844: COPYRIGHT.md file is not (a useful) Markdown format

Submitter:  Mike Miller <mtmiller>
Submitted:  Tue 18 Feb 2020 12:23:56 AM UTC
   
 
Category:  Documentation Severity:  1 - Wish
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Open/Closed:  * Closed
Release:  * 5.2.0 Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Tue 18 Feb 2020 01:23:51 PM UTC, comment #4: 

Yes, I used some scripts initially, but even the first version that was checked in to the mercurial archive was edited by hand.  So it is intended to be maintained manually now, not generated from other sources.

John W. Eaton <jwe>
Group administrator
Tue 18 Feb 2020 08:40:24 AM UTC, comment #3: 

I dug through my email archives and jwe said he did use a script, but didn't commit it to the repository. So I went ahead and fixed the Markdown syntax, and compared it to the copy that Kai committed to the web-octave repository, and all looks good now. Pushed on the stable branch:

https://hg.savannah.gnu.org/hgweb/octave/rev/c8e40b19c499

Mike Miller <mtmiller>
Group Member
Tue 18 Feb 2020 04:06:38 AM UTC, comment #2: 

Agreed, it is not a useful display of the information.  The file is marked in Mercurial as being a controlled file, so it may be okay to modify it directly (add hyphen and space) and then check the changes in.  I don't believe there is auto-generation of the file.

Rik <rik5>
Group administrator
Tue 18 Feb 2020 12:24:51 AM UTC, comment #1: 

This shows the Markdown rendering of the file in the source tree that I mean is not useful:

https://github.com/mtmiller/octave/blob/master/COPYRIGHT.md

Mike Miller <mtmiller>
Group Member
Tue 18 Feb 2020 12:23:56 AM UTC, original submission:  

The file COPYRIGHT.md in the source tree has a Markdown file extension, but it's not actually in Markdown format.

Specifically, the list of contributors starting on line 19 is one long run-on paragraph in Markdown format, not a bulleted list like it is on the octave.org web site.

Preferably each line in the contributor list would start with a hyphen and a space '- '. Is there a script used to update or keep this file in sync with hg metadata? Can we add the bullet syntax without making things too difficult?

Mike Miller <mtmiller>
Group Member

 

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

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by jwe (Posted a comment)
  • -email is unavailable- added by rik5 (Posted a comment)
  •  

    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
    2020-02-18 mtmiller StatusConfirmed Fixed
        Open/ClosedOpen Closed
    2020-02-18 rik5 StatusNone Confirmed
    2020-02-18 mtmiller Carbon-CopyRemoved 80942 -

    Back to the top

    Powered by Savane 3.13-d3ae.
    Corresponding source code