asciidoctor / asciidoctorj

:coffee: Java bindings for Asciidoctor. Asciidoctor on the JVM!
http://asciidoctor.org
Apache License 2.0
617 stars 172 forks source link

Fixes #1237. -s CLI option should be changed to -e to align with Asci… #1238

Closed robertpanzer closed 8 months ago

robertpanzer commented 8 months ago

…idoctor

Thank you for opening a pull request and contributing to AsciidoctorJ!

Please take a bit of time giving some details about your pull request:

Kind of change

Description

What is the goal of this pull request?

Fix #1237 and change the command line option -e so that it creates an embedded document instead of selecting eRuby.

How does it achieve that?

Add a new cli option --embedded with the short key -e. Change --eruby so that it doesn't have any short key.

Are there any alternative ways to implement this?

Likely not.

Are there any implications of this pull request? Anything a user must know?

I also removed the explicit mentionings of the defaults in the argument descriptions, since jcommander also shows the defaults, e.g.,:

    -e, --embedded
      suppress enclosing document structure and output an embedded document
      Default: false
    --eruby
      specify eRuby implementation to render built-in templates: [erb, erubis]
      Default: erb

Issue

If this PR fixes an open issue, please add a line of the form:

Fixes #1237