www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - [dlang] Mistakes in documentation

reply "Chris" <wendlec tcd.ie> writes:
I noticed some mistakes in

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

I haven't checked the whole page for mistakes, but I suggest we 
change the following paragraph:

[Current]
Here is where regular expressions come in handy, often succinctly 
called as regexes. Regexes are simple yet powerful language for 
defining patterns of strings, put together with a substitution 
mechanism, they form a Swiss Army knife of text processing. They 
are considered so useful that a number of languages provides 
built-in support for regular expressions. This does not nessary 
mean that built-in implies faster processing or more features. 
It's more a matter of providing convenient and friendly syntax 
for typical operations and usage patterns.

[Suggestion]
Here is where regular expressions – often just called 
<i>regexes</i> – come in handy. Regular expressions are a simple 
yet comprehensive language for defining string patterns. Combined 
with a mechanism for string substitution, regular expressions are 
a powerful tool for text processing. In fact, they are considered 
so useful that a number of languages provide built-in support for 
them. However, built-in support does <b>not</b> necessarily imply 
<b>faster</b> processing or more features, it is rather a way of 
providing a <b>convenient and user-friendly syntax</b> for 
typical operations and usage patterns.

[something along these lines]
May 19 2015
parent reply "H. S. Teoh via Digitalmars-d" <digitalmars-d puremagic.com> writes:
On Tue, May 19, 2015 at 01:43:13PM +0000, Chris via Digitalmars-d wrote:
 I noticed some mistakes in
 
 http://dlang.org/regular-expression.html
 
 I haven't checked the whole page for mistakes, but I suggest we change the
 following paragraph:
 
 [Current]
 Here is where regular expressions come in handy, often succinctly called as
 regexes. Regexes are simple yet powerful language for defining patterns of
 strings, put together with a substitution mechanism, they form a Swiss Army
 knife of text processing. They are considered so useful that a number of
 languages provides built-in support for regular expressions. This does not
 nessary mean that built-in implies faster processing or more features. It's
 more a matter of providing convenient and friendly syntax for typical
 operations and usage patterns.
 
 [Suggestion]
 Here is where regular expressions – often just called <i>regexes</i> – come
 in handy. Regular expressions are a simple yet comprehensive language for
 defining string patterns. Combined with a mechanism for string substitution,
 regular expressions are a powerful tool for text processing. In fact, they
 are considered so useful that a number of languages provide built-in support
 for them. However, built-in support does <b>not</b> necessarily imply
 <b>faster</b> processing or more features, it is rather a way of providing a
 <b>convenient and user-friendly syntax</b> for typical operations and usage
 patterns.
 
 [something along these lines]
Let's see the PR! ;-) T -- Philosophy: how to make a career out of daydreaming.
May 19 2015
next sibling parent reply "Chris" <wendlec tcd.ie> writes:
On Tuesday, 19 May 2015 at 14:29:10 UTC, H. S. Teoh wrote:
 On Tue, May 19, 2015 at 01:43:13PM +0000, Chris via 
 Digitalmars-d wrote:
 I noticed some mistakes in
 
 http://dlang.org/regular-expression.html
 
 I haven't checked the whole page for mistakes, but I suggest 
 we change the
 following paragraph:
 
 [Current]
 Here is where regular expressions come in handy, often 
 succinctly called as
 regexes. Regexes are simple yet powerful language for defining 
 patterns of
 strings, put together with a substitution mechanism, they form 
 a Swiss Army
 knife of text processing. They are considered so useful that a 
 number of
 languages provides built-in support for regular expressions. 
 This does not
 nessary mean that built-in implies faster processing or more 
 features. It's
 more a matter of providing convenient and friendly syntax for 
 typical
 operations and usage patterns.
 
 [Suggestion]
 Here is where regular expressions – often just called 
 <i>regexes</i> – come
 in handy. Regular expressions are a simple yet comprehensive 
 language for
 defining string patterns. Combined with a mechanism for string 
 substitution,
 regular expressions are a powerful tool for text processing. 
 In fact, they
 are considered so useful that a number of languages provide 
 built-in support
 for them. However, built-in support does <b>not</b> 
 necessarily imply
 <b>faster</b> processing or more features, it is rather a way 
 of providing a
 <b>convenient and user-friendly syntax</b> for typical 
 operations and usage
 patterns.
 
 [something along these lines]
Let's see the PR! ;-) T
Can I pull it? I didn't know it was "pullable", else I would've pulled it already. (No pun in 10 did!)
May 19 2015
parent "Liam McSherry" <mcsherry.liam gmail.com> writes:
On Tuesday, 19 May 2015 at 14:37:58 UTC, Chris wrote:
 Can I pull it? I didn't know it was "pullable", else I would've 
 pulled it already. (No pun in 10 did!)
The specific bit of documentation you were talking about is here: https://github.com/D-Programming-Language/phobos/blob/master/std/regex/package.d You'll need a GitHub account to pull the repo and file a PR.
May 19 2015
prev sibling parent "Chris" <wendlec tcd.ie> writes:
On Tuesday, 19 May 2015 at 14:29:10 UTC, H. S. Teoh wrote:
 On Tue, May 19, 2015 at 01:43:13PM +0000, Chris via 
 Digitalmars-d wrote:
 I noticed some mistakes in
 
 http://dlang.org/regular-expression.html
 
 I haven't checked the whole page for mistakes, but I suggest 
 we change the
 following paragraph:
 
 [Current]
 Here is where regular expressions come in handy, often 
 succinctly called as
 regexes. Regexes are simple yet powerful language for defining 
 patterns of
 strings, put together with a substitution mechanism, they form 
 a Swiss Army
 knife of text processing. They are considered so useful that a 
 number of
 languages provides built-in support for regular expressions. 
 This does not
 nessary mean that built-in implies faster processing or more 
 features. It's
 more a matter of providing convenient and friendly syntax for 
 typical
 operations and usage patterns.
 
 [Suggestion]
 Here is where regular expressions – often just called 
 <i>regexes</i> – come
 in handy. Regular expressions are a simple yet comprehensive 
 language for
 defining string patterns. Combined with a mechanism for string 
 substitution,
 regular expressions are a powerful tool for text processing. 
 In fact, they
 are considered so useful that a number of languages provide 
 built-in support
 for them. However, built-in support does <b>not</b> 
 necessarily imply
 <b>faster</b> processing or more features, it is rather a way 
 of providing a
 <b>convenient and user-friendly syntax</b> for typical 
 operations and usage
 patterns.
 
 [something along these lines]
Let's see the PR! ;-) T
Done. https://github.com/D-Programming-Language/dlang.org/pull/997
May 19 2015