Closed (fixed)
Project:
Drupal core
Version:
8.0.x-dev
Component:
documentation
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
26 Jul 2015 at 18:37 UTC
Updated:
2 Mar 2016 at 02:34 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
jhodgdonThanks! Good idea to add more information here...
But when I read this:
I went ... Really? I don't see any plugin definitions or plugin IDs there, or if they are, it isn't obvious. They're things like:
To me, "plugin definition" is a class...
I guess I see what you mean here but when I read that I went uh, what?
Let's see. What can we say. How about this:
These YAML files contain contextual link entries, keyed by an ID. Each entry gives the properties of an implicit contextual link plugin, as defined by this interface, with the ID being the plugin ID.
How about that to replace that sentence that begins with "These YAML files" in this patch?
Comment #2
jhodgdonSorry, never updated issue status on this. Should we still fix this?
Comment #3
chx commented> To me, "plugin definition" is a class...
Not really. The plugin definition can be a Doctrine annotation which is then stored in an object and then the plugin manager can reveal this to the rest of the system as just an array or another value object. But this is not necessary: it definitely can be in a YAML file or if you write a custom discovery as I did for the upcoming migration plugin can be a YAML file by itself.
Now, a plugin, that's a class, for sure.
I will look into this more.
Comment #4
jhodgdonFair enough, yes I see what you mean -- these are actually plugin definitions... How about wording something like this:
These YAML files contain a list of contextual link plugin definitions, keyed by plugin ID. Each definition must define....
Needs comma before "and".
Comment #5
priya.chat commentedHello, I have tried to made some changes as commented by @jhodgdon. Please review it.
Comment #7
shreya shetty commentedComment #8
shreya shetty commentedHi jhodgdon ,
Thank you for suggestion .I have made the changes accordingly.
Comment #9
jhodgdonNeither the patch in #5 nor the patch in #8 really did what was suggested in #4. Please try again.
Also by the way you need to say "ID" not "id", which I forgot to mention in #4.
And all documentation lines should be wrapped as close to 80 characters as possible without going over.
Comment #10
rang501 commentedHi!
I hope I got this right.
FYI, I made a slight change (grammatically it should be more correct): modulename.links.contextual.yml to module_name.links.contextual.yml
Comment #11
jhodgdonThis looks great to me, thanks!
Comment #12
catchCommitted/pushed to 8.1.x and cherry-picked to 8.0.x. Thanks!