Thread overview | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
July 27, 2016 Docs: Links to source code | ||||
---|---|---|---|---|
| ||||
For one reason or another I sometimes find myself checking out the implementation of functions in Phobos. For this I have to go to the module file on Github, e.g. this one [1], and look for the function (that often has more than one implementation). Wouldn't it be nice to have a direct link from the documentation of the function to the source code? Is that feasible at all? [1] https://github.com/dlang/phobos/blob/master/std/algorithm/searching.d |
July 27, 2016 Re: Docs: Links to source code | ||||
---|---|---|---|---|
| ||||
Posted in reply to Chris | Am 27.07.2016 um 11:43 schrieb Chris: > For one reason or another I sometimes find myself checking out the > implementation of functions in Phobos. For this I have to go to the > module file on Github, e.g. this one [1], and look for the function > (that often has more than one implementation). Wouldn't it be nice to > have a direct link from the documentation of the function to the source > code? Is that feasible at all? > > [1] https://github.com/dlang/phobos/blob/master/std/algorithm/searching.d The new docs have that: http://dlang.org/library/std/algorithm/searching/all.html (click the "View source code" link at the top of the page) |
July 27, 2016 Re: Docs: Links to source code | ||||
---|---|---|---|---|
| ||||
Posted in reply to Sönke Ludwig | On Wednesday, 27 July 2016 at 09:56:44 UTC, Sönke Ludwig wrote:
> Am 27.07.2016 um 11:43 schrieb Chris:
>> For one reason or another I sometimes find myself checking out the
>> implementation of functions in Phobos. For this I have to go to the
>> module file on Github, e.g. this one [1], and look for the function
>> (that often has more than one implementation). Wouldn't it be nice to
>> have a direct link from the documentation of the function to the source
>> code? Is that feasible at all?
>>
>> [1] https://github.com/dlang/phobos/blob/master/std/algorithm/searching.d
>
> The new docs have that:
> http://dlang.org/library/std/algorithm/searching/all.html
>
> (click the "View source code" link at the top of the page)
Great! Maybe "View source code" could be either more visible (stronger color/gray) or near the function name. The reason I say this is that a lot of people will not find it and ask here where the link to the source code is.
|
July 27, 2016 Re: Docs: Links to source code | ||||
---|---|---|---|---|
| ||||
Posted in reply to Chris | On Wednesday, 27 July 2016 at 09:43:45 UTC, Chris wrote:
> For one reason or another I sometimes find myself checking out the implementation of functions in Phobos. For this I have to go to the module file on Github
for this kind of stuff I use the IDE code navigation facilities.
import std.stuff;
stu|ff
CTRL+SHIFT+UP or Ctrl+Click
The web is a source of distraction. You open the browser and you have already 250 new RSS items that are here to pull you from your current actibity.
|
July 27, 2016 Re: Docs: Links to source code | ||||
---|---|---|---|---|
| ||||
Posted in reply to lkfsdg | On Wednesday, 27 July 2016 at 10:29:12 UTC, lkfsdg wrote:
>
> for this kind of stuff I use the IDE code navigation facilities.
>
> import std.stuff;
>
> stu|ff
>
> CTRL+SHIFT+UP or Ctrl+Click
>
> The web is a source of distraction. You open the browser and you have already 250 new RSS items that are here to pull you from your current actibity.
The point is that it should be easily accessible on the web, regardless of personal preferences or workflows ;)
|
July 27, 2016 Re: Docs: Links to source code | ||||
---|---|---|---|---|
| ||||
Posted in reply to Chris | On Wednesday, 27 July 2016 at 10:34:10 UTC, Chris wrote:
> On Wednesday, 27 July 2016 at 10:29:12 UTC, lkfsdg wrote:
>>
>> for this kind of stuff I use the IDE code navigation facilities.
>>
>> import std.stuff;
>>
>> stu|ff
>>
>> CTRL+SHIFT+UP or Ctrl+Click
>>
>> The web is a source of distraction. You open the browser and you have already 250 new RSS items that are here to pull you from your current actibity.
>
> The point is that it should be easily accessible on the web, regardless of personal preferences or workflows ;)
Understood, but I found your argumentation fallacious. Actually I have nothing against your idea.
|
July 27, 2016 Re: Docs: Links to source code | ||||
---|---|---|---|---|
| ||||
Posted in reply to lkfsdg | On Wednesday, 27 July 2016 at 10:47:57 UTC, lkfsdg wrote:
> On Wednesday, 27 July 2016 at 10:34:10 UTC, Chris wrote:
>> On Wednesday, 27 July 2016 at 10:29:12 UTC, lkfsdg wrote:
>>>
>>> for this kind of stuff I use the IDE code navigation facilities.
>>>
>>> import std.stuff;
>>>
>>> stu|ff
>>>
>>> CTRL+SHIFT+UP or Ctrl+Click
>>>
>>> The web is a source of distraction. You open the browser and you have already 250 new RSS items that are here to pull you from your current actibity.
>>
>> The point is that it should be easily accessible on the web, regardless of personal preferences or workflows ;)
>
> Understood, but I found your argumentation fallacious. Actually I have nothing against your idea.
Out of interest, why was it fallacious? I always use the online docs.
|
July 27, 2016 Re: Docs: Links to source code | ||||
---|---|---|---|---|
| ||||
Posted in reply to Chris | On Wednesday, 27 July 2016 at 10:54:37 UTC, Chris wrote:
> On Wednesday, 27 July 2016 at 10:47:57 UTC, lkfsdg wrote:
>> On Wednesday, 27 July 2016 at 10:34:10 UTC, Chris wrote:
>>> On Wednesday, 27 July 2016 at 10:29:12 UTC, lkfsdg wrote:
>>>>
>>>> for this kind of stuff I use the IDE code navigation facilities.
>>>>
>>>> import std.stuff;
>>>>
>>>> stu|ff
>>>>
>>>> CTRL+SHIFT+UP or Ctrl+Click
>>>>
>>>> The web is a source of distraction. You open the browser and you have already 250 new RSS items that are here to pull you from your current actibity.
>>>
>>> The point is that it should be easily accessible on the web, regardless of personal preferences or workflows ;)
>>
>> Understood, but I found your argumentation fallacious. Actually I have nothing against your idea.
>
> Out of interest, why was it fallacious? I always use the online docs.
You argueed that it would be nice to have this feature because you often have to browse on GH. That's fallacious because I've shown that it can be done locally. your original argument doesn't stand. You see the logic ;)
|
July 27, 2016 Re: Docs: Links to source code | ||||
---|---|---|---|---|
| ||||
Posted in reply to lkfsdg | On Wednesday, 27 July 2016 at 11:01:14 UTC, lkfsdg wrote:
> On Wednesday, 27 July 2016 at 10:54:37 UTC, Chris wrote:
>>
>> Out of interest, why was it fallacious? I always use the online docs.
>
> You argueed that it would be nice to have this feature because you often have to browse on GH. That's fallacious because I've shown that it can be done locally. your original argument doesn't stand. You see the logic ;)
Sorry, your argument was fallacious, because it was based on the assumption that everybody uses an IDE, the same as you do at that. Also, with your argumentation ("it can be done locally"), we could get rid of online dictionaries, encyclopedias etc., because I (might) have one on my desk - or I might have downloaded it to my local machine. No, your logic doesn't hold.
And when you skim through the docs online, as I do sometimes to see if a functionality I need is in Phobos, it's pretty handy to be able to jump from there to GH.
|
July 27, 2016 Re: Docs: Links to source code | ||||
---|---|---|---|---|
| ||||
Posted in reply to Chris | On Wednesday, 27 July 2016 at 11:09:59 UTC, Chris wrote:
> On Wednesday, 27 July 2016 at 11:01:14 UTC, lkfsdg wrote:
>> [...]
>
> Sorry, your argument was fallacious, because it was based on the assumption that everybody uses an IDE, the same as you do at that. Also, with your argumentation ("it can be done locally"), we could get rid of online dictionaries, encyclopedias etc., because I (might) have one on my desk - or I might have downloaded it to my local machine. No, your logic doesn't hold.
>
> And when you skim through the docs online, as I do sometimes to see if a functionality I need is in Phobos, it's pretty handy to be able to jump from there to GH.
IDE or text editor with special features for D, everytbody uses one, although to write code you actually only need paper and pen. A computer is only usefull to compile.
|
Copyright © 1999-2021 by the D Language Foundation