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

XeEoListener.java:52-55: Change severity on comments... #2860

Open
0pdd opened this issue Feb 5, 2024 · 1 comment
Open

XeEoListener.java:52-55: Change severity on comments... #2860

0pdd opened this issue Feb 5, 2024 · 1 comment

Comments

@0pdd
Copy link

0pdd commented Feb 5, 2024

The puzzle 2841-24b89c01 from #2841 has to be resolved:

* @todo #2841:30min Change severity on comments validation. Current severity on comments validation
* is "warning". We need to change it to "error" to prevent users from ignoring this type of error.
* But firstly we have to make "eo-runtime" documented well. After it's done - we need to turn
* on "failOnWarning" trigger in pom.xml inside "eo-runtime.

The puzzle was created by rultor on 05-Feb-24.

Estimate: 30 minutes, role: DEV.

If you have any technical questions, don't ask me, submit new tickets instead. The task will be "done" when the problem is fixed and the text of the puzzle is removed from the source code. Here is more about PDD and about me.

@maxonfjvipon
Copy link
Member

The main goal here - to write a description/documentation for every named abstract object in eo-runtime module. The description should:

  1. start with capital letter
  2. end with dot
  3. consist of at least 64 characters
  4. explain the main purpose of the object
  5. [optional, but preferable] show an example of usage

After all objects are documented, we will get rid of noisy logs and can change severity on comments validation.

It's not necessarily to document all objects in one pull request. 3-5 would be enough.

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