search

Raku / RakuDoc-GAMMA

Community review of the RakuDoc standard
Artistic License 2.0
2 stars 1 forks source link

The DOC phaser #51

Open finanalyst opened 4 hours ago

finanalyst commented 4 hours ago

@thoughtstream Your thoughts on the following are sought. @lizmat @vrurg please extend if need be.

Some time ago I was asking how to implement DOC use Module, see user defined blocks. At the time there was a strong objection to the idea in that a RakuDoc source should have any knowledge of its environment, or of the output format. I raised the topic again at the Raku Steering Council today. The objection remains.

The DOC phaser does not seem to do anything in Rakudo. So I wonder whether we should remove all mention of DOC phaser from 'The DOC phaser' upto but not including 'If a renderer'.

The specification already provides a mechanism for handling a Custom block that a renderer does not recognise. (There is another concern here, but I'm raising another issue for that)

thoughtstream commented 2 hours ago

If it’s been decided that Raku is not going with the original design of supporting user-defined “documentation modules” via DOC phasers, then – yes – we should definitely remove any mention of DOC from the spec.