Thread overview
[Issue 129] DDoc downgrades enum to their integer initializers
[Issue 129] DDoc makes enum values cryptic
Feb 10, 2017
Timothee Cour
Feb 10, 2017
Timothee Cour
Feb 10, 2017
Timothee Cour
Sep 19, 2017
Iain Buclaw
Oct 20, 2017
Andrew Edwards
Oct 20, 2017
Andrew Edwards
Oct 20, 2017
Iain Buclaw
Oct 28, 2017
Andrew Edwards
February 10, 2017
https://issues.dlang.org/show_bug.cgi?id=129

Timothee Cour <timothee.cour2@gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|RESOLVED                    |REOPENED
                 CC|                            |timothee.cour2@gmail.com
            Version|D1 (retired)                |D2
         Resolution|FIXED                       |---

--- Comment #10 from Timothee Cour <timothee.cour2@gmail.com> ---
https://dlang.org/library/std/process/pipe_process.html shows:

ProcessPipes pipeProcess(
  const(char[][]) args,
  Redirect redirect = cast(Redirect)7,
  const(string[string]) env = cast(const(string[string]))null,
  Config config = cast(Config)0,
  const(char[]) workDir = null
) @safe;


with

cast(Redirect)7,

instead of

Redirect redirect = Redirect.all,

as in source code

--
February 10, 2017
https://issues.dlang.org/show_bug.cgi?id=129

--- Comment #11 from Timothee Cour <timothee.cour2@gmail.com> ---
(In reply to Timothee Cour from comment #10)
> https://dlang.org/library/std/process/pipe_process.html shows:
> 
> ProcessPipes pipeProcess(
>   const(char[][]) args,
>   Redirect redirect = cast(Redirect)7,
>   const(string[string]) env = cast(const(string[string]))null,
>   Config config = cast(Config)0,
>   const(char[]) workDir = null
> ) @safe;
> 
> 
> with
> 
> cast(Redirect)7,
> 
> instead of
> 
> Redirect redirect = Redirect.all,
> 
> as in source code

what's worse is that https://issues.dlang.org/show_bug.cgi?id=9695 was marked as wontfix, making it impossible to lookup enum values for an integer

Also discussed here: https://issues.dlang.org/show_bug.cgi?id=17171

--
February 10, 2017
https://issues.dlang.org/show_bug.cgi?id=129

Timothee Cour <timothee.cour2@gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
            Summary|DDoc makes enum values      |DDoc downgrades enum to
                   |cryptic                     |their integer initializers

--
September 19, 2017
https://issues.dlang.org/show_bug.cgi?id=129

Iain Buclaw <ibuclaw@gdcproject.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |ibuclaw@gdcproject.org

--- Comment #12 from Iain Buclaw <ibuclaw@gdcproject.org> ---
(In reply to Timothee Cour from comment #10)
> https://dlang.org/library/std/process/pipe_process.html shows:
> 
> ProcessPipes pipeProcess(
>   const(char[][]) args,
>   Redirect redirect = cast(Redirect)7,
>   const(string[string]) env = cast(const(string[string]))null,
>   Config config = cast(Config)0,
>   const(char[]) workDir = null
> ) @safe;
> 
> 
> with
> 
> cast(Redirect)7,
> 
> instead of
> 
> Redirect redirect = Redirect.all,
> 
> as in source code

Interestingly, when compiling a minimal test - just the enum declarations and the pipeProcess function - the ddoc generated looks fine.


---

Declaration

@safe ProcessPipes pipeProcess(in char[][] args, Redirect redirect = Redirect.all, const string[string] env = null, Config config = Config.none, in char[] workDir = null);

---

I think this should be closed, and other issues stemming from handled in their respective report numbers.

--
October 20, 2017
https://issues.dlang.org/show_bug.cgi?id=129

Andrew Edwards <edwards.ac@gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |edwards.ac@gmail.com

--- Comment #13 from Andrew Edwards <edwards.ac@gmail.com> ---
(In reply to Timothee Cour from comment #10)
> https://dlang.org/library/std/process/pipe_process.html shows:
> 
> ProcessPipes pipeProcess(
>   const(char[][]) args,
>   Redirect redirect = cast(Redirect)7,
>   const(string[string]) env = cast(const(string[string]))null,
>   Config config = cast(Config)0,
>   const(char[]) workDir = null
> ) @safe;
> 
> 
> with
> 
> cast(Redirect)7,
> 
> instead of
> 
> Redirect redirect = Redirect.all,
> 
> as in source code

This is a byproduct of DDOX, not DDOC. See issue 17171 comment 2.

As stated in comment 9, this issue is again verified resolved in both 1.076 and 2.077.0-beta.1.

--
October 20, 2017
https://issues.dlang.org/show_bug.cgi?id=129

--- Comment #14 from Andrew Edwards <edwards.ac@gmail.com> ---
(In reply to Iain Buclaw from comment #12)
> 
> Interestingly, when compiling a minimal test - just the enum declarations and the pipeProcess function - the ddoc generated looks fine.
> 

Correct, this is a DDOX issue, not DDOC.

> 
> I think this should be closed, and other issues stemming from handled in their respective report numbers.

Will be closed in 1 week, pending feedback to issue 17171 comment2.

--
October 20, 2017
https://issues.dlang.org/show_bug.cgi?id=129

--- Comment #15 from Iain Buclaw <ibuclaw@gdcproject.org> ---
Ok. Thanks for the explanation.

--
October 28, 2017
https://issues.dlang.org/show_bug.cgi?id=129

Andrew Edwards <edwards.ac@gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|REOPENED                    |RESOLVED
         Resolution|---                         |FIXED

--