Skip to content

Remove select-get from Language Reference Docs #1747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

tbrinkman3
Copy link

Already documented in the Book. Removing duplicate location. See: #1744

@tbrinkman3 tbrinkman3 changed the title Remove select get Remove select-get from Language Reference Docs Jan 13, 2025
@fdncred
Copy link
Contributor

fdncred commented Jan 13, 2025

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.

@NotTheDr01ds
Copy link
Contributor

NotTheDr01ds commented Jan 13, 2025

@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.

@fdncred
Copy link
Contributor

fdncred commented Jan 13, 2025

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.

@NotTheDr01ds
Copy link
Contributor

@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. :-)

@fdncred
Copy link
Contributor

fdncred commented Feb 4, 2025

@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".

@NotTheDr01ds
Copy link
Contributor

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
Copy link
Contributor

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?

@fdncred
Copy link
Contributor

fdncred commented Feb 4, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants