Skip to content

Find a way to make example message be fully shown without usage of regexp  #13740

@romani

Description

@romani

Detected at #13731 (comment)

value of line length set low on purpose for Example files, to keep them very concise and short.
Reason is we try to be very short on width in examples to be sure that example code is easy to read.

This message needs 120

annotation.missing.deprecated=Must include both @java.lang.Deprecated annotation and @deprecated Javadoc tag with description.

but try to stay on limit 80.

We can cut message to:
// violation below 'Must include .* @deprecated Javadoc tag with description.'

may be in cases where .* is not avoidable, we will improve macros code to search replace it to ... to more natural for humans
// violation below 'Must include ... @deprecated Javadoc tag with description.'

Usage of .... proposal on how we can work around too technical .*.

To make fix easy we can update our matching to violation message with tiny code that search-replace any ... to .*.

we should not use 3 dot elipsis because it is already used in java:
public void myMethod(String... strings) as three dots already in use in java.
We can use 4 dots .....

Update:
See comments , as proposed solution is changed.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions