Skip to content
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

Closed
wants to merge 5 commits into from
Closed

Add annotation to glossary #6177

wants to merge 5 commits into from

Conversation

DerStoffel
Copy link
Contributor

Q A
Doc fix? no
New docs? yes
Applies to all
Fixed tickets #6175

@javiereguiluz
Copy link
Member

@DerStoffel thanks for this improvement. I like your definition ... except for the first phrase:

Annotations are notes written above your code.

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:

Annotations are metadata written alongside your code.

@DerStoffel
Copy link
Contributor Author

@javiereguiluz Done and pushed.

I was not sure about metadata, since it is a very biased definition in software-development.
But what works for wikipedia, should also work for us 👍 😄

@xabbuh
Copy link
Member

xabbuh commented Jan 22, 2016

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.

@DerStoffel
Copy link
Contributor Author

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.

@xabbuh
Copy link
Member

xabbuh commented Jan 22, 2016

👍

@wouterj
Copy link
Member

wouterj commented Feb 6, 2016

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.

@wouterj wouterj closed this Feb 6, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants