search

libxml-raku / LibXML-raku

Raku bindings to the libxml2 native library
Artistic License 2.0
11 stars 5 forks source link

Manual method documentation conflicts with Raku declarators (via Pod::To::Markdown) #34

Closed dwarring closed 4 years ago

dwarring commented 4 years ago

Manual method documentation style is typically:

=begin item
my-method

description here
=end item

Which produces markdown:

### my-method

description here

Compare this with declarator blocks in source code:

#| description here
method my-method() { ... }

Which produces markdown:

method my-method
-----

Description here.

I'm not sure now where the former convention came from. But it conflicts and make it difficult to mix the two.

I suggest following the latter convention or switch to using Pod declarators

dwarring commented 4 years ago

Going down the path of using Pod decorators. Have done LibXML::Document as an example. Others will follow.

dwarring commented 4 years ago

Largely done. Included in LibXML 0.4.0 release