-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Add annotation to glossary #6177
Conversation
DerStoffel
commented
Jan 21, 2016
Q | A |
---|---|
Doc fix? | no |
New docs? | yes |
Applies to | all |
Fixed tickets | #6175 |
@DerStoffel thanks for this improvement. I like your definition ... except for the first phrase:
Wikipedia defines annotations as "metadata" to the source code. I consider that definition more precise. So, if you agree, could you change your first phrase by:
|
@javiereguiluz Done and pushed. I was not sure about metadata, since it is a very biased definition in software-development. |
Not sure if we should add a note saying that annotations are placed in docblocks or if that isn't too much for the glossary. But besides that this looks good to me. |
Thought about that myself and chose not to. Had the feeling that it might be confusting towards @doc annotations or non-config annotations, which are technically placed in the docbloc, but not only for documentation purposes. |
👍 |
Hi @DerStoffel! Thanks for creating this pull request. As you've done a merge in your branch, I couldn't get this in the 2.3 branch cleanly. This is why I took your commits and created a clean branch + new PR: #6230 I'll merge that one now instead. As the commits are kept, you will still recieve all credits. |