Skip to content
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

Should NYI features be documented? #4485

Open
lizmat opened this issue Jun 10, 2024 · 4 comments
Open

Should NYI features be documented? #4485

lizmat opened this issue Jun 10, 2024 · 4 comments
Assignees
Labels
docs Documentation issue (primary issue type) meta RFCs, general discussion, writing style, repository organization, etc.

Comments

@lizmat
Copy link
Collaborator

lizmat commented Jun 10, 2024

After this discussion:

https://www.reddit.com/r/ProgrammerHumor/comments/1dbypb8/comment/l7va938/

I wonder whether we should remove ::= from the documentation. And any other features marked NYI. Especially if they never may get implemented.

@lizmat lizmat added the docs Documentation issue (primary issue type) label Jun 10, 2024
@coke
Copy link
Collaborator

coke commented Jun 10, 2024

I think 10 years ago it made sense to note NYI - not now. Will look into a cleanup.

@coke coke self-assigned this Jun 10, 2024
@coke coke added the meta RFCs, general discussion, writing style, repository organization, etc. label Jun 10, 2024
@coke coke added this to the 2024-Quarter-2 milestone Jun 10, 2024
coke added a commit that referenced this issue Jun 10, 2024
@coke
Copy link
Collaborator

coke commented Jun 10, 2024

The biggest remaining hits are from doc/Type/independent-routines.rakudoc, all related to sprintf - I know you've done some work on modernizing that in the past, can I ask you to go through that page and see if it makes sense to comment out the NYI sections or just remove them entirely?

@lizmat
Copy link
Collaborator Author

lizmat commented Jun 10, 2024

Heh, quite a can of worms :-)

So, all printf / fmt related stuff in 6.e will be based on Formatter class. However I'm still not sure whether that should be an implementation-detail class or not. Because later a Format class was created.

I will mull over this in the coming days!

@coke
Copy link
Collaborator

coke commented Jun 10, 2024

Oops. We didn't have many NYI items, but SO MANY "not.*implemented"

coke added a commit that referenced this issue Jun 16, 2024
@coke coke modified the milestones: 2024-Quarter-2, 2024-Quarter-3 Jul 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issue (primary issue type) meta RFCs, general discussion, writing style, repository organization, etc.
Projects
None yet
Development

No branches or pull requests

2 participants