[ https://issues.apache.org/jira/browse/LUCENE-8115?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Christine Poerschke updated LUCENE-8115: ---------------------------------------- Attachment: LUCENE-8115-step2.patch bq. ... do i have that correct? Yes, you do. Attached patch clarifies the message associated with the check to _"\{@inheritDoc\} on its own is unnecessary"_. bq. I feel like i'm missing some context/background info here ... The context here is that an automatic style check and enforcement like this seemed to me to be a logical follow-on from [~dsmiley]'s [comment|https://issues.apache.org/jira/browse/SOLR-11801?focusedCommentId=16306388&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-16306388] on SOLR-11801 i.e. if tools can pick up on things like this then human code reviewers can focus more on other things and/or code readers are not distracted by the unnecessary @inheritDoc clutter and/or code writers are encouraged to add supplemental information alongside the @inheritDoc. > fail precommit on unnecessary {@inheritDoc} use > ----------------------------------------------- > > Key: LUCENE-8115 > URL: https://issues.apache.org/jira/browse/LUCENE-8115 > Project: Lucene - Core > Issue Type: Task > Reporter: Christine Poerschke > Assignee: Christine Poerschke > Priority: Minor > Attachments: LUCENE-8115-step2.patch, LUCENE-8115-step2.patch > > > * Step 1: identify and remove existing unnecessary {{\{@inheritDoc\}}} use > e.g. via IDE tooling or {{git grep -C 1 inheritDoc}}. > * Step 2: change {{ant validate}} so that precommit fails if/when any new > unnecessary {{\{@inheritDoc\}}} are introduced. -- This message was sent by Atlassian JIRA (v6.4.14#64029) --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org