www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - D Language Specification

reply Dibyendu Majumdar <d.majumdar gmail.com> writes:
Hi,

I am interested in working on this in my spare time. How do I get 
started - i.e. what is the process for submitting changes to the 
spec?

Regards
Dibyendu
May 13 2019
next sibling parent reply Eugene Wissner <belka caraus.de> writes:
On Monday, 13 May 2019 at 15:46:36 UTC, Dibyendu Majumdar wrote:

 Hi,

 I am interested in working on this in my spare time. How do I 
 get started - i.e. what is the process for submitting changes 
 to the spec?

 Regards
 Dibyendu


Do you mean language changes or specification text improvements?

The spec itself is here: 
https://github.com/dlang/dlang.org/tree/master/spec
For language changes see 
https://github.com/dlang/DIPs/blob/master/PROCEDURE.md
May 13 2019
parent reply Dibyendu Majumdar <d.majumdar gmail.com> writes:
On Monday, 13 May 2019 at 15:51:22 UTC, Eugene Wissner wrote:

 On Monday, 13 May 2019 at 15:46:36 UTC, Dibyendu Majumdar wrote:

 I am interested in working on this in my spare time. How do I 
 get started - i.e. what is the process for submitting changes 
 to the spec?


 Do you mean language changes or specification text improvements?


Specification text improvements.


 The spec itself is here: 
 https://github.com/dlang/dlang.org/tree/master/spec


Thank you - so changes should be submitted via pull requests?

Regards
May 13 2019
parent reply Eugene Wissner <belka caraus.de> writes:
On Monday, 13 May 2019 at 15:55:15 UTC, Dibyendu Majumdar wrote:

 On Monday, 13 May 2019 at 15:51:22 UTC, Eugene Wissner wrote:

 On Monday, 13 May 2019 at 15:46:36 UTC, Dibyendu Majumdar 
 wrote:

 I am interested in working on this in my spare time. How do I 
 get started - i.e. what is the process for submitting changes 
 to the spec?


 Do you mean language changes or specification text 
 improvements?


 Specification text improvements.


 The spec itself is here: 
 https://github.com/dlang/dlang.org/tree/master/spec


 Thank you - so changes should be submitted via pull requests?

 Regards


yes, I think it is sufficient.
May 13 2019
parent reply Dibyendu Majumdar <d.majumdar gmail.com> writes:
On Monday, 13 May 2019 at 15:59:34 UTC, Eugene Wissner wrote:

 The spec itself is here: 
 https://github.com/dlang/dlang.org/tree/master/spec


 Thank you - so changes should be submitted via pull requests?


 yes, I think it is sufficient.


Apologies if this question has been asked before. Is there a 
reason why the spec cannot be written in something like 
RestructuredText or Markdown? I ask because github natively 
supports these formats, which makes it easier / more productive.

Thanks and Regards
Dibyendu
May 13 2019
next sibling parent Russel Winder <russel winder.org.uk> writes:
On Tue, 2019-05-14 at 01:20 +0000, Dibyendu Majumdar via Digitalmars-d
wrote:

 On Monday, 13 May 2019 at 15:59:34 UTC, Eugene Wissner wrote:

 The spec itself is here:=20
 https://github.com/dlang/dlang.org/tree/master/spec


=20
 Thank you - so changes should be submitted via pull requests?
=20


 yes, I think it is sufficient.


=20
 Apologies if this question has been asked before. Is there a=20
 reason why the spec cannot be written in something like=20
 RestructuredText or Markdown? I ask because github natively=20
 supports these formats, which makes it easier / more productive.


Or better still AsciiDoc.

I know choice of source format creates quasi-religious warfare and/or
bikeshedding, but AsciiDoc (with the AsciiDoctor toolchain) is superior
on all but one metric. That metric being mindshare: Markdown seems all
pervasive, but as soon as you want to do anything that is not trivial
it fails.
=20

 Thanks and Regards
 Dibyendu


--=20
Russel.
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Dr Russel Winder      t: +44 20 7585 2200
41 Buckmaster Road    m: +44 7770 465 077
London SW11 1EN, UK   w: www.russel.org.uk
May 13 2019
prev sibling parent reply Bastiaan Veelo <Bastiaan Veelo.net> writes:
On Tuesday, 14 May 2019 at 01:20:01 UTC, Dibyendu Majumdar wrote:

 On Monday, 13 May 2019 at 15:59:34 UTC, Eugene Wissner wrote:

 The spec itself is here: 
 https://github.com/dlang/dlang.org/tree/master/spec


 Thank you - so changes should be submitted via pull requests?


 yes, I think it is sufficient.


 Apologies if this question has been asked before. Is there a 
 reason why the spec cannot be written in something like 
 RestructuredText or Markdown? I ask because github natively 
 supports these formats, which makes it easier / more productive.

 Thanks and Regards
 Dibyendu


All of dlang.org (as far as I can see) is written in ddoc, the D 
embedded documentation format https://dlang.org/spec/ddoc.html. 
It produces output in various formats, not just HTML. If you 
don’t want to set up your local build of the website, then you 
can still make the pull requests and inspect the results as built 
by the testing bots that will be accessible from the PR page. 
While you are iterating, you may want to prepend your PR title 
with “[WIP]”.

Bastiaan.
May 14 2019
next sibling parent reply Mike Franklin <slavo5150 yahoo.com> writes:
On Tuesday, 14 May 2019 at 07:47:36 UTC, Bastiaan Veelo wrote:


 While you are iterating, you may want to prepend your PR title 
 with “[WIP]”.


While the "[WIP]" prefix still works, the preferred method is to 
create a draft PR.  See 
https://github.blog/2019-02-14-introducing-draft-pull-requests/

Mike
May 14 2019
parent Bastiaan Veelo <Bastiaan Veelo.net> writes:
On Tuesday, 14 May 2019 at 07:49:58 UTC, Mike Franklin wrote:

 While the "[WIP]" prefix still works, the preferred method is 
 to create a draft PR.  See 
 https://github.blog/2019-02-14-introducing-draft-pull-requests/

 Mike


Cool!
May 14 2019
prev sibling next sibling parent reply Dibyendu Majumdar <d.majumdar gmail.com> writes:
On Tuesday, 14 May 2019 at 07:47:36 UTC, Bastiaan Veelo wrote:

 Apologies if this question has been asked before. Is there a 
 reason why the spec cannot be written in something like 
 RestructuredText or Markdown? I ask because github natively 
 supports these formats, which makes it easier / more 
 productive.


 All of dlang.org (as far as I can see) is written in ddoc, the 
 D embedded documentation format 
 https://dlang.org/spec/ddoc.html. It produces output in various 
 formats, not just HTML. If you don’t want to set up your local 
 build of the website, then you can still make the pull requests 
 and inspect the results as built by the testing bots that will 
 be accessible from the PR page. While you are iterating, you 
 may want to prepend your PR title with “[WIP]”.


Thank you for the tips.

I am happy to work with ddoc but it seems unnecessary friction.

Regards
May 14 2019
parent reply Seb <seb wilzba.ch> writes:
On Tuesday, 14 May 2019 at 08:41:53 UTC, Dibyendu Majumdar wrote:

 On Tuesday, 14 May 2019 at 07:47:36 UTC, Bastiaan Veelo wrote:

 Apologies if this question has been asked before. Is there a 
 reason why the spec cannot be written in something like 
 RestructuredText or Markdown? I ask because github natively 
 supports these formats, which makes it easier / more 
 productive.


 All of dlang.org (as far as I can see) is written in ddoc, the 
 D embedded documentation format 
 https://dlang.org/spec/ddoc.html. It produces output in 
 various formats, not just HTML. If you don’t want to set up 
 your local build of the website, then you can still make the 
 pull requests and inspect the results as built by the testing 
 bots that will be accessible from the PR page. While you are 
 iterating, you may want to prepend your PR title with “[WIP]”.


 Thank you for the tips.

 I am happy to work with ddoc but it seems unnecessary friction.

 Regards


I have some good news: starting with the 2.086 release, Ddoc 
supports markdown via the experimental -preview=markdown flag and 
the plan is to enable it soon for dlang.org.
May 14 2019
parent Dibyendu Majumdar <d.majumdar gmail.com> writes:
On Tuesday, 14 May 2019 at 09:14:16 UTC, Seb wrote:

 I have some good news: starting with the 2.086 release, Ddoc 
 supports markdown via the experimental -preview=markdown flag 
 and the plan is to enable it soon for dlang.org.


That's great. I look forward to when this will be enabled, in the 
meantime I will work with the ddoc format.

Regards
May 14 2019
prev sibling parent reply Dibyendu Majumdar <d.majumdar gmail.com> writes:
On Tuesday, 14 May 2019 at 07:47:36 UTC, Bastiaan Veelo wrote:

 All of dlang.org (as far as I can see) is written in ddoc, the 
 D embedded documentation format 
 https://dlang.org/spec/ddoc.html. It produces output in various 
 formats, not just HTML. If you don’t want to set up your local 
 build of the website, then you can still make the pull requests 
 and inspect the results as built by the testing bots that will 
 be accessible from the PR page. While you are iterating, you 
 may want to prepend your PR title with “[WIP]”.


I tried the workflow suggested above. Unfortunately it takes very 
long for the build (why?),  so it is not very practical to work 
this way.

Regards
May 14 2019
parent reply Andrei Alexandrescu <SeeWebsiteForEmail erdani.com> writes:
On 5/14/19 11:35 AM, Dibyendu Majumdar wrote:

 On Tuesday, 14 May 2019 at 07:47:36 UTC, Bastiaan Veelo wrote:

 All of dlang.org (as far as I can see) is written in ddoc, the D 
 embedded documentation format https://dlang.org/spec/ddoc.html. It 
 produces output in various formats, not just HTML. If you don’t want 
 to set up your local build of the website, then you can still make the 
 pull requests and inspect the results as built by the testing bots 
 that will be accessible from the PR page. While you are iterating, you 
 may want to prepend your PR title with “[WIP]”.


 
 I tried the workflow suggested above. Unfortunately it takes very long 
 for the build (why?),  so it is not very practical to work this way.


What I do is just build the "html" target while iterating.
May 14 2019
parent Seb <seb wilzba.ch> writes:
On Tuesday, 14 May 2019 at 17:10:13 UTC, Andrei Alexandrescu 
wrote:

 On 5/14/19 11:35 AM, Dibyendu Majumdar wrote:

 On Tuesday, 14 May 2019 at 07:47:36 UTC, Bastiaan Veelo wrote:

[...]


 
 I tried the workflow suggested above. Unfortunately it takes 
 very long for the build (why?),  so it is not very practical 
 to work this way.


 What I do is just build the "html" target while iterating.


Yep, you can even add a bit of parallelization to make it faster:

$ cd ~/dlang/dlang.org
$ make -f posix.mak html -j20
May 14 2019
prev sibling parent Bastiaan Veelo <Bastiaan Veelo.net> writes:
On Monday, 13 May 2019 at 15:46:36 UTC, Dibyendu Majumdar wrote:

 Hi,

 I am interested in working on this in my spare time. How do I 
 get started - i.e. what is the process for submitting changes 
 to the spec?

 Regards
 Dibyendu


Thank you. It looks like you have watched the AGM and are acting 
upon an important point from it. If not, please watch 
https://youtu.be/cpTAtiboIDs?t=6324.

Bastiaan.
May 14 2019