September 15, 2013 Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
I finally gathered strength to rebase https://github.com/D-Programming-Language/dlang.org/pull/271 manually, which was every bit as involved as I feared. I hope I didn't mess up anything, reviews appreciated. That diff includes a new page navigation scheme. (Wasn't the main purpose of the diff but found it a nice perk.) I see it as a transitional stage toward the larger transition to one-page-per-entity that Sönke has proposed. Check out the new navigation at http://erdani.com/d/phobos/std_array.html. The ugly "Jump to" list as the top gets replaced by a slick drop-down. Once you jump to a name, you can go back by pressing the up arrow on the right or simply go to top. Andrei |
September 15, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On 9/15/13 15:14, Andrei Alexandrescu wrote: > I finally gathered strength to rebase > https://github.com/D-Programming-Language/dlang.org/pull/271 manually, > which was every bit as involved as I feared. > > I hope I didn't mess up anything, reviews appreciated. > > That diff includes a new page navigation scheme. (Wasn't the main > purpose of the diff but found it a nice perk.) I see it as a > transitional stage toward the larger transition to one-page-per-entity > that Sönke has proposed. > > Check out the new navigation at > http://erdani.com/d/phobos/std_array.html. The ugly "Jump to" list as > the top gets replaced by a slick drop-down. Once you jump to a name, you > can go back by pressing the up arrow on the right or simply go to top. > > > Andrei Could you have a look at https://github.com/D-Programming-Language/dmd/pull/2121 ? I'm not sure what's holding that PR up, no concerns were raised, but it would greatly improve the quality of the documentation. L. |
September 15, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Sunday, 15 September 2013 at 07:14:15 UTC, Andrei Alexandrescu wrote: > Check out the new navigation at http://erdani.com/d/phobos/std_array.html. The ugly "Jump to" list as the top gets replaced by a slick drop-down. Once you jump to a name, you can go back by pressing the up arrow on the right or simply go to top. I'm not sure this is an improvement, functionally. Finding the right item in much faster when you can see all items at once, and not lined up on only one direction. Also, Ctrl+F was more likely to find the link to the correct item before than now (and if you used your browser's inline search feature, then you could activate that link by pressing Enter). I think some kind of outline would be more useful. What happened with Ddox? This looks like an improvement in both function and aesthetics: http://vibed.org/temp/phobos/std/array.html |
September 15, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On 9/15/2013 12:14 AM, Andrei Alexandrescu wrote:
> I hope I didn't mess up anything, reviews appreciated.
Can you build the .mobi file with these changes?
|
September 15, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | Andrei Alexandrescu:
> http://erdani.com/d/phobos/std_array.html
One thing I'd like is for every function a link to the GitHub page & line of code where that Phobos function is defined. This is handy because I sometimes need to take a look at the implementation of functions I use. And I think that encourages people to fix the documentation faster, etc.
Another small ddoc improvement, is for each of the recently introduced functions a small note that tells compiler version number when it appeared.
Bye,
bearophile
|
September 15, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Vladimir Panteleev | On Sunday, 15 September 2013 at 07:53:23 UTC, Vladimir Panteleev wrote:
> On Sunday, 15 September 2013 at 07:14:15 UTC, Andrei Alexandrescu wrote:
>> Check out the new navigation at http://erdani.com/d/phobos/std_array.html. The ugly "Jump to" list as the top gets replaced by a slick drop-down. Once you jump to a name, you can go back by pressing the up arrow on the right or simply go to top.
>
> I'm not sure this is an improvement, functionally. Finding the right item in much faster when you can see all items at once, and not lined up on only one direction. Also, Ctrl+F was more likely to find the link to the correct item before than now (and if you used your browser's inline search feature, then you could activate that link by pressing Enter).
>
> I think some kind of outline would be more useful.
>
> What happened with Ddox? This looks like an improvement in both function and aesthetics:
>
> http://vibed.org/temp/phobos/std/array.html
I tend to agree with Vladimir...
- Paolo
|
September 15, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On 2013-09-15 09:14, Andrei Alexandrescu wrote: > I finally gathered strength to rebase > https://github.com/D-Programming-Language/dlang.org/pull/271 manually, > which was every bit as involved as I feared. > > I hope I didn't mess up anything, reviews appreciated. > > That diff includes a new page navigation scheme. (Wasn't the main > purpose of the diff but found it a nice perk.) I see it as a > transitional stage toward the larger transition to one-page-per-entity > that Sönke has proposed. > > Check out the new navigation at > http://erdani.com/d/phobos/std_array.html. The ugly "Jump to" list as > the top gets replaced by a slick drop-down. Once you jump to a name, you > can go back by pressing the up arrow on the right or simply go to top. I don't like that it requires JavaScript. -- /Jacob Carlborg |
September 15, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Paolo Invernizzi | On 2013-09-15 11:03, Paolo Invernizzi wrote: > I tend to agree with Vladimir... +1 -- /Jacob Carlborg |
September 15, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Jacob Carlborg Attachments:
| On Sep 15, 2013 11:25 AM, "Jacob Carlborg" <doob@me.com> wrote: > > On 2013-09-15 09:14, Andrei Alexandrescu wrote: >> >> I finally gathered strength to rebase https://github.com/D-Programming-Language/dlang.org/pull/271 manually, which was every bit as involved as I feared. >> >> I hope I didn't mess up anything, reviews appreciated. >> >> That diff includes a new page navigation scheme. (Wasn't the main purpose of the diff but found it a nice perk.) I see it as a transitional stage toward the larger transition to one-page-per-entity that Sönke has proposed. >> >> Check out the new navigation at http://erdani.com/d/phobos/std_array.html. The ugly "Jump to" list as the top gets replaced by a slick drop-down. Once you jump to a name, you can go back by pressing the up arrow on the right or simply go to top. > > > I don't like that it requires JavaScript. > I could give it a test using librejs to make sure that the site isn't using non-free JS. Regards -- Iain Buclaw *(p < e ? p++ : p) = (c & 0x0f) + '0'; |
September 15, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Iain Buclaw | On 2013-09-15 12:45, Iain Buclaw wrote: > I could give it a test using librejs to make sure that the site isn't > using non-free JS. I don't like that it uses JavaScript regardless if it's free or not. By default I run with JavaScript off. Then I enable it on sites I use often that really needs it. -- /Jacob Carlborg |
Copyright © 1999-2021 by the D Language Foundation