doc icon indicating copy to clipboard operation
doc copied to clipboard

Should NYI features be documented?

Open lizmat opened this issue 1 year ago • 4 comments

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 avatar Jun 10 '24 14:06 lizmat

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

coke avatar Jun 10 '24 14:06 coke

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?

coke avatar Jun 10 '24 14:06 coke

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!

lizmat avatar Jun 10 '24 16:06 lizmat

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

coke avatar Jun 10 '24 16:06 coke