Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Asciidoctor extension for gettting package names #256

Open
lordofthejars opened this issue Nov 2, 2017 · 3 comments
Open

Create Asciidoctor extension for gettting package names #256

lordofthejars opened this issue Nov 2, 2017 · 3 comments

Comments

@lordofthejars
Copy link
Member

Issue Overview

Currently in several parts of the documentation, we are hardcoding the fully qualified class name. So if we refactor the package then the documentation becomes outdated.

Expected Behaviour

Creates an asciidoctor extension for reading package and classname from file directly.
In case of the file is not found we can log a warn message.

Current Behaviour

We need to hardcode the package.

@bartoszmajsak
Copy link
Member

In case of the file is not found we can log a warn message.

Shouldn't we fail the build to fix it?

@lordofthejars
Copy link
Member Author

I know that this would be the logical thing, but if you notice all in Asciidoctor does not fail but just shows warnings. Asciidoctor always tries to do its best not failing. You can test it for example with callouts, you can define a callout that does not exists and you'll receive a warning but not an exception.

@bartoszmajsak
Copy link
Member

Ok, that is fine. Then I guess we should adjust the build script to fail if such pattern occurs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants