nushell.github.io icon indicating copy to clipboard operation
nushell.github.io copied to clipboard

Remove select-get from Language Reference Docs

Open tbrinkman3 opened this issue 11 months ago • 8 comments

Already documented in the Book. Removing duplicate location. See: https://github.com/nushell/nushell.github.io/pull/1744

tbrinkman3 avatar Jan 13 '25 14:01 tbrinkman3

I don't think it's a good idea to remove sections from the language guide because they're documented in the book. The language guide performs a slightly different task than the book and things like this should be minimally documented in the guide.

fdncred avatar Jan 13 '25 15:01 fdncred

@fdncred To be fair, I added that page and TODO in the Language Guide a while back, then added the select/get info to the Book but forgot to remove it from the Language Guide. If there's something specific we need in the language guide regarding this, then I'm okay with leaving the placeholder, but it's my "fault" it's in there in the first place, so I'm okay with it coming out if you are.

NotTheDr01ds avatar Jan 13 '25 21:01 NotTheDr01ds

I think the language guide should have every language related item in it. Even if it's just a high-level blurb that points to more in-depth documentation.

fdncred avatar Jan 13 '25 21:01 fdncred

@fdncred (Delayed response) That's fair, but considering this is only a page with a "TODO" on it, I think we should remove it for now and add something in when we have real text, right? There are literally hundreds of potential TODO pages still to be written in the Language Guide. :-)

NotTheDr01ds avatar Feb 04 '25 21:02 NotTheDr01ds

@NotTheDr01ds I'm up for whatever, but imo, i'd rather see TODOs because it shows potential contributors what's missing and specifically where they could jump in and help. If there are no TODOs, one would think that it's complete, which it is far from. Or even some other blurb that conveys that same intent, "Please help by documenting this section".

fdncred avatar Feb 04 '25 21:02 fdncred

No worries - I don't have strong feelings on it either; it's just that we don't have many other TODOs today. Perhaps the Language Guide should be an exception there, since it still needs a lot of content.

NotTheDr01ds avatar Feb 04 '25 22:02 NotTheDr01ds

I guess the question is - Should we land some version of #1744 then? Or what would you see as the "Language Guide" version of this section?

NotTheDr01ds avatar Feb 04 '25 22:02 NotTheDr01ds

Ya, I'd just have a small-ish blurb like that PR for get/set.

fdncred avatar Feb 04 '25 22:02 fdncred