Thread overview | ||||||
---|---|---|---|---|---|---|
|
November 02, 2021 Re: Documentation improvements needed for versioning | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Tuesday, 2 November 2021 at 22:07:19 UTC, Andrei Alexandrescu wrote: > 2. The public imports should link to the imported stuff: adrdox does this now on my box http://dpldocs.info/experimental-docs/testimport.html It lists out each selective import on its own line then you can override the doc comment if you want on the import itself, or otherwise it will look up the original item's comment. This is what it looks like in a more real case right now: http://dpldocs.info/experimental-docs/std.string.html#public-imports Not sure I love it. I might take the selective ones and just merge them into the general members list. But undecided so far. Aliases and selective imports work essentially the same way, so figuring it out for one will also do it for the other. |
November 02, 2021 Re: Documentation improvements needed for versioning | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Tuesday, 2 November 2021 at 22:07:19 UTC, Andrei Alexandrescu wrote:
> I just took a look at various docs generated for
>
> 1. The new mismatch does not look good:
>
> [...]
And this folks is why you want to run the experiment. Before it, you don't even know what questions will come up (in the hypothetical future), and it's quite hard answering a question you haven't even formulated yet 😎
|
November 03, 2021 Re: Documentation improvements needed for versioning | ||||
---|---|---|---|---|
| ||||
Posted in reply to Imperatorn | On 2021-11-02 19:40, Imperatorn wrote:
> On Tuesday, 2 November 2021 at 22:07:19 UTC, Andrei Alexandrescu wrote:
>> I just took a look at various docs generated for
>>
>> 1. The new mismatch does not look good:
>>
>> [...]
>
> And this folks is why you want to run the experiment. Before it, you don't even know what questions will come up (in the hypothetical future), and it's quite hard answering a question you haven't even formulated yet 😎
Great point, thanks.
Related update: Walter gave a cautious thumbs to the strategy and said we want to push exploration a bit further before taking any decisive steps.
|
Copyright © 1999-2021 by the D Language Foundation