0.29 update documentation about OPT_UNSAFE

nwellnhof / perl-commonmark

Perl bindings for the CommonMark C library

https://metacpan.org/release/CommonMark

Other

5 stars 7 forks source link

0.29 update documentation about OPT_UNSAFE #10

Closed bes-internal closed 4 years ago

bes-internal commented 5 years ago

please update the documentation in pod:

parse option
Parser options section
if possible, detail with examples show how to work with "$ options is a bit field containing the parser options"
is what really OPT_DEFAULT?

nwellnhof commented 4 years ago

The documentation of OPT_UNSAFE was updated with the commit introducing it: https://github.com/nwellnhof/perl-commonmark/commit/a6e4053e671370c6bdcac40fdf267bd69f2dea1f

Using a bit field for options (which are typically combined with binary OR) is a widely-used concept. OPT_DEFAULT equals 0, so it doesn't set any options.