Closed (fixed)
Project:
Drupal core
Version:
8.0.x-dev
Component:
documentation
Priority:
Minor
Category:
Task
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
7 Jul 2013 at 18:22 UTC
Updated:
29 Jul 2014 at 22:38 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
panchoI'm not sure that's necessary. Did you encounter an error?
Our docs are parsed by IDEs and tools that don't know our "placeholder" class. Also there's no precedence in core.
Comment #2
droplet commentedhmm. When developers read the docs, they don't know it added placeholder class to drupal_placeholder. Is it an error ??
Sorry, I don't understand this point ??
Comment #3
jhodgdonWhat are you trying to do here? If you want to say that the text is made into an em HTML tag and the class on that tag is "placeholder", then this is not the right way to do it -- you should state that in plain English in the API documentation instead. If you are trying to do something else, then... what?
Comment #4
droplet commentedYES.
OK, anybody can rewrite it into plain English or whatever meet Drupal Standard. Thanks.
Comment #5
pancho@droplet: Oh, this has not been your fault.
I thought you wanted it to be rendered with that class, and just didn't get why you would want that... :)
But yeah, it certainly makes sense to document the class that is being added. The question is, if we can use (unescaped) HTML tags in docs. For example PHPDoc parses
<b>or<i>in HTML but leaves<strong>or<em>alone, so according to their docs it would actually work. Drupal's API module doesn't parse anything in HTML, so it work there anyway. IDE's might have a different take on it.To be on the secure side, we should probably avoid it, but:
- firstly it was already there (you added just the class)
- secondly our Docs Styleguide doesn't mention anything about it.
Quite more tricky than a Novice issue.
We might even want to escalate this, so we get a clear decision we can add to the styleguide.
Comment #6
jhodgdonPlease just make a plain English text describing what happens, like "makes an HTML em tag with class foo" and you can use @code @endcode around the tag to get it to show up as <em> on api.drupal.org if you want. The other entries in this help text could be fixed up too.
Comment #6.0
jhodgdonUpdated issue summary.
Comment #7
pushpinderchauhan commentedAdded @code @endcode around the tag to get it to show up as on api.drupal.org if you want. Please review.
Comment #8
jhodgdonThanks... But I do not think that the text makes sense if you use @code/@endcode to show exactly what HTML markup is being used. The text should say something like "... which makes the following HTML code:", and I don't think making the text inside the EM tag say "emphasized" actually makes any sense at all for the sample -- put something like "text output here" or some other more sensible placeholder.
Comment #9
pushpinderchauhan commented@jhodgdon thanks!
Please review this one.
Comment #10
jhodgdonMuch better, thanks!
Comment #11
alexpottCommitted 48eabc0 and pushed to 8.x. Thanks!
Comment #12
jhodgdonThe link to your commit didn't work and the auto-commit message didn't show up. Are you sure that was committed? I'm not seeing the change in the repo...
Comment #13
alexpott