Remove usage of @inheritdoc #866
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maks-rafalko
approved these changes
Nov 28, 2019
There was a problem hiding this comment.
I'm also taking this opportunity to introduce an ADR file (thanks @Ocramius for the recommendation) which is a useful technique to document some decisions taken.
I also wanted to introduce this technic, so a big 👍 here
Just one question - did you use some tool that generates them (e.g. file name, folder path, controls the structure of the document, etc.)? I remember there was a tool for ADR...
|
Did not, I just followed a random template that looked good enough for not at least. I think we can also adjust the template/format depending of our need without having to retrofit all the existing ones unless there is a real value. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #860
I could find a way to check for the
@inheritdoctags but honestly the solution was way too slow & expansive. Since there is very little usage, I just removed it and I believe we can keep it under control with the PR review.I'm also taking this opportunity to introduce an ADR file (thanks @Ocramius for the recommendation) which is a useful technique to document some decisions taken.