D issues are now tracked on GitHub. This Bugzilla instance remains as a read-only archive.
Issue 20272 - Add standard section "Limitations" to ddoc
Summary: Add standard section "Limitations" to ddoc
Status: NEW
Alias: None
Product: D
Classification: Unclassified
Component: dmd (show other issues)
Version: D2
Hardware: All All
: P4 enhancement
Assignee: No Owner
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2019-10-06 14:34 UTC by Berni
Modified: 2024-12-13 19:05 UTC (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description Berni 2019-10-06 14:34:26 UTC
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.
Comment 1 Seb 2019-10-06 21:44:23 UTC
Ddoc doesn't have pre-defined sections. It uses the colon to do so.

So as long as you write sth along:

Limitations:
   Your limitations here.

This will be displayed similarly to the other "sections".

Ddoc supports custom macros with which you could create a custom warning . However, it doesn't look like we'll get custom warning boxes (https://github.com/dlang/dlang.org/pull/2308).
Comment 2 Berni 2019-10-07 07:17:31 UTC
Similarly, but not identically. See discussion of https://github.com/dlang/phobos/pull/7199
Comment 3 dlangBugzillaToGithub 2024-12-13 19:05:48 UTC
THIS ISSUE HAS BEEN MOVED TO GITHUB

https://github.com/dlang/dmd/issues/19627

DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB