phobos/changelog
2017-12-14 03:46:34 +01:00
..
README.md Move changelog to a folder and use single file entries 2017-01-06 23:38:04 +01:00
std-algorithm-iteration-mean.dd Fix issue 14034: Add mean to Phobos 2017-11-21 18:23:12 -05:00
std-algorithm-searching-findSkip.dd Add the new findSkip overload to the change log 2017-11-20 13:32:54 +01:00
std-array-bypair.dd Add changelog entry for changed return type of std.array.byPair 2017-11-28 17:23:44 +01:00
std-container-dlist-linearRemoveElement.dd Changelog update for Dlist and Slist linearRemoveElement 2017-10-25 13:50:10 +03:00
std-container-slist-linearRemoveElement.dd Changelog update for Dlist and Slist linearRemoveElement 2017-10-25 13:50:10 +03:00
std-range-package-Transposed-deprecate-save.dd Improve wording in the Transposed changelog entry 2017-12-12 13:43:14 +01:00
std-typecons-ternary-opBinary.dd Update std-typecons-ternary-opBinary.dd 2017-12-14 03:46:34 +01:00

This directory will get copied to dlang.org and cleared when master gets merged into stable prior to a new release.

How to add a new changelog entry to the pending changelog?

Create a new file in the changelog folder. It should end with .dd and look similar to a git commit message. The first line represents the title of the change. After an empty line follows the long description:

My fancy title of the new feature

A long description of the new feature in `std.range`.
It can be followed by an example:
-------
import std.range : padLeft, padRight;
import std.algorithm.comparison : equal;

assert([1, 2, 3, 4, 5].padLeft(0, 7).equal([0, 0, 1, 2, 3, 4, 5]));

assert("Hello World!".padRight('!', 15).equal("Hello World!!!!"));
-------
and links to the documentation, e.g. $(REF drop, std, range) or
$(REF_ALTTEXT a custom name for the function, drop, std, range).

Links to the spec can look like this $(LINK2 $(ROOT_DIR)spec/module.html, this)
and of course you can link to other $(LINK2 https://forum.dlang.org/, external resources).

The title can't contain links (it's already one). For more infos, see the Ddoc spec.

Preview changes

If you have cloned the tools and dlang.org repo), you can preview the changelog with:

make -C ../dlang.org -f posix.mak pending_changelog