• d-bugmail puremagic.com (25/25) Oct 06 2019 https://issues.dlang.org/show_bug.cgi?id=20272

d-bugmail puremagic.com writes:

https://issues.dlang.org/show_bug.cgi?id=20272

          Issue ID: 20272
           Summary: Add standard section "Limitations" to ddoc
           Product: D
           Version: D2
          Hardware: All
                OS: All
            Status: NEW
          Severity: enhancement
          Priority: P1
         Component: dmd
          Assignee: nobody puremagic.com
          Reporter: dlang croco-puzzle.com

It would be nice to have an additional section "Limitations". In this section,
stuff, that does not work, but is not considered a bug, can be documented.

For example: In std.zip I used it, without being aware that this is not a
standard section. Among others, this section describes, that some compression
methods and encryption is not supported.

One more usecase: abs from std.math does not work correctly for int.min (and
other signed integral types). Fixing this causes trouble or slows down the
code. (Same for std.algorithm.comparison: min with NaNs). To avoid this, it's
better to document the limitations. Putting this in the "Bugs" section would
cause some confusions, because a bug is something, that should be fixed sooner
or later. But here we already decided to not fix it.

--