Removed grammatical mistakes from paragraph 'Here is where regular e…

[Doado]

…xpressions'.

Made some minor stylistic changes and also changed bold font to italic font (admittedly a matter of taste).

[McSherry]

I don't think the italics on lines 20/22 add anything to the doc. IMO, the emphasis the italics provide makes the sentence read a bit oddly.

[Doado]

Sure, I agree. They don't really add anything.

[CyberShadow]

If there is consensus, let's remove them and merge?

[McSherry]

Along with my comment on the diff, this should probably be a pull on the Phobos repo (this file) so documentation generated from in-code docs is correct.

I imagine that the docs in this repo are autogenerated from the source code, so changing the documentation comments in the Phobos repo will update the docs in here on the next release.

[Doado]

Along with my comment on the diff, this should probably be a pull on the
Phobos repo (this file
https://github.com/D-Programming-Language/phobos/blob/master/std/regex/package.d)
so documentation generated from in-code docs are correct.

I don't get this bit (yet). I'm new to PRs.

On Tue, May 19, 2015 at 4:28 PM, Liam McSherry notifications@github.com
wrote:

Along with my comment on the diff, this should probably be a pull on the
Phobos repo (this file
https://github.com/D-Programming-Language/phobos/blob/master/std/regex/package.d)
so documentation generated from in-code docs are correct.

I imagine that the docs in this repo are autogenerated from the source
code, so changing the documentation comments in the Phobos repo will update
the docs in here on the next release.

—
Reply to this email directly or view it on GitHub
#997 (comment)
.

[McSherry]

The Phobos repository contains the source code for D's standard library. D supports, in its source code, documentation comments. For example:

/**
 * Multiplies a number by four.
 * 
 * Params:
 *     number = The number to quadruple.
 * 
 * Returns:
 *     The provided number multiplied by four.
*/
auto quadruple(int number)
{
    return number * 4;
}

From these in-code comments, you can then generate documentation (like that on the D website, and in this repository). Because the documentation is generated from the source code, the change needs to be made to the source code, otherwise regenerating the documentation would overwrite the change with the old text.

To make the change to the source code, you'll need to pull the Phobos repository and change the documentation in the std\regex\package.d file. Then, when the documentation is next generated from the source code, your change will be there.

[Doado]

I understand that the documentation is generated from the Phobos source
files with ddoc. But I don't understand why a change to a page that is not
in Phobos (or any other library doc), in this case
http://dlang.org/regular-expression.html, needs to be pulled in Phobos.

On Tue, May 19, 2015 at 4:55 PM, Liam McSherry notifications@github.com
wrote:

The Phobos repository contains the source code for D's standard library. D
supports, in its source code, documentation comments. For example:

/* * Multiplies a number by four. * * Params: * number = The number to quadruple. * * Returns: * The provided number multiplied by four./auto quadruple(int number)
{
return number * 4;
}

From these in-code comments, you can then generate documentation (like
that on the D website, and in this repository). Because the documentation
is generated from the source code, the change needs to be made to the
source code, otherwise regenerating the documentation would overwrite the
change with the old text.

To make the change to the source code, you'll need to pull the Phobos
https://github.com/D-Programming-Language/phobos/ repository and change
the documentation in the std\regex\package.d file. Then, when the
documentation is next generated from the source code, your change will be
there.

—
Reply to this email directly or view it on GitHub
#997 (comment)
.

[CyberShadow]

I imagine that the docs in this repo are autogenerated from the source code, so changing the documentation comments in the Phobos repo will update the docs in here on the next release.

No.

This pull request changes:

http://dlang.org/regular-expression.html

This is a dlang.org article that stands separately from the Phobos module documentation:

http://dlang.org/phobos/std_regex.html
http://dlang.org/library/std/regex.html

[Doado]

Thanks for clarifying this, Vladimir. I was already wondering.

On Tue, May 19, 2015 at 5:09 PM, Vladimir Panteleev <
notifications@github.com> wrote:

I imagine that the docs in this repo are autogenerated from the source
code, so changing the documentation comments in the Phobos repo will update
the docs in here on the next release.

No.

This pull request changes:

http://dlang.org/regular-expression.html

This is a dlang.org article that stands separately from the Phobos module
documentation:

http://dlang.org/phobos/std_regex.html
http://dlang.org/library/std/regex.html

—
Reply to this email directly or view it on GitHub
#997 (comment)
.

[McSherry]

No.

This pull request changes:

http://dlang.org/regular-expression.html

Whoops, didn't see that. My mistake, I thought this was a change to the docs rather than an article.