[jira] [Commented] (LUCENE-8115) fail precommit on unnecessary {@inheritDoc} use

["Hoss Man (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/LUCENE-8115?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16308571#comment-16308571 ] 

Hoss Man commented on LUCENE-8115:
----------------------------------

I feel like i'm missing some context/background info here (possible because i'm very behind on my email and this jira just happened to catch my eye)...

when/why/how has it been decided that using \@inheritDoc is unnecessary?

> 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
>
>
> * 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-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org