Thread overview
[Issue 1427] New: Generated .di files look ugly and are hard to read
Aug 17, 2007
d-bugmail
Nov 27, 2011
Kenji Hara
Nov 20, 2012
Walter Bright
Jan 16, 2013
Walter Bright
August 17, 2007
http://d.puremagic.com/issues/show_bug.cgi?id=1427

           Summary: Generated .di files look ugly and are hard to read
           Product: D
           Version: 1.020
          Platform: PC
        OS/Version: Windows
            Status: NEW
          Severity: enhancement
          Priority: P2
         Component: DMD
        AssignedTo: bugzilla@digitalmars.com
        ReportedBy: wbaxter@gmail.com


Header files can be a good source of documentation for competent programmers. By stripping out all the implementation cruft, a header file gives you a concise summary of all the types and functions a module provides in a format that is easy to navigate and search with a simple text editor.  HTML Docs provide a concise summary too, but require firing up a browser and since we are programmers who spend the majority of our time writing code, it's usually easier to just open up a header file than dig through a bunch of web pages.

So the point of all this is to say that .di files should be generated with a human reader in mind.  Currently the generated files throw away almost all formatting, which makes them very hard for a human to read.

There's no reason why the di generator can not also be a source beautifier at the same time, generating source code with even more consistent indentation and formatting than the original code.


-- 

November 27, 2011
http://d.puremagic.com/issues/show_bug.cgi?id=1427


Kenji Hara <k.hara.pg@gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           Keywords|                            |patch


--- Comment #1 from Kenji Hara <k.hara.pg@gmail.com> 2011-11-26 19:02:19 PST ---
D2 patch: https://github.com/D-Programming-Language/dmd/pull/538

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
November 20, 2012
http://d.puremagic.com/issues/show_bug.cgi?id=1427



--- Comment #2 from github-bugzilla@puremagic.com 2012-11-19 20:47:32 PST ---
Commits pushed to master at https://github.com/D-Programming-Language/dmd

https://github.com/D-Programming-Language/dmd/commit/8664473ee4bf6bc5d51e390a697848afe769eced Issue 1427 - Generated .di files look ugly and are hard to read

https://github.com/D-Programming-Language/dmd/commit/0c93ce24e80087ad2beb59db723955dbd5e2715b Merge pull request #538 from 9rnsr/fix1427

Issue 1427 - Generated .di files look ugly and are hard to read

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
November 20, 2012
http://d.puremagic.com/issues/show_bug.cgi?id=1427


Walter Bright <bugzilla@digitalmars.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |bugzilla@digitalmars.com
            Version|1.020                       |D1 & D2


--- Comment #3 from Walter Bright <bugzilla@digitalmars.com> 2012-11-19 23:14:19 PST ---
Fixed for D2 only.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
January 16, 2013
http://d.puremagic.com/issues/show_bug.cgi?id=1427



--- Comment #4 from Walter Bright <bugzilla@digitalmars.com> 2013-01-16 14:59:56 PST ---
https://github.com/D-Programming-Language/dmd/pull/1487

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------