Closed (fixed)
Project:
Drupal core
Version:
8.0.x-dev
Component:
documentation
Priority:
Normal
Category:
Task
Assigned:
Issue tags:
Reporter:
Created:
23 Jan 2013 at 22:26 UTC
Updated:
14 Apr 2015 at 16:14 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
jhodgdonProbably a good Novice project.
Comment #2
rteijeiro commentedpcambra I am working on it ;)
Comment #3
rteijeiro commentedComment #4
rteijeiro commentedAlso replaced "@var boolean" declarations.
Attached complete patch. Hope it's right.
Comment #5
droplet commentedexclude 3rd party scripts ?
Comment #6
tstoecklerDespite not living in core/vendor ArchiveTar is also an external file and should be excluded as well.
Comment #7
lars toomre commentedI understood that these type of patches that touch many files were not going to be committed until after the new feature deadline in February. Good to see this one being developed in anticipation.
It looks like you missed the '@var Boolean' in ..\Core\Database\Transaction.php. I did not see any others in a quick scan.b
As a follow up to this issue, other "basic" house-cleaning documentation issues like this one include:
- 'array' instead of 'Array' in @return, @param and @var directives,
- 'int' instead of 'integer' in @return, @param and @var directives,
- leading slash before these three directives for strings like '@param Drupal\' and '@param Symphony', and
- a global clean up of 'Contains ' replacing 'Definition of ' in the core class files.
Comment #8
rteijeiro commentedUpdating issue title
Comment #9
jhodgdonLet's leave this issue just for "boolean", and leave the issue title as it was. Separate issues can be filed for the other issues if necessary.
And yes, as mentioned above (sorry, forgot to think of this): Definitely don't touch any files with /vendor/ in their path, or ArchiveTar, which should be in /vendor/ but isn't (don't even ask).
Comment #10
lars toomre commentedA somewhat related issue is the use of the lower case term 'boolean' in the @param/return/var directive descriptions. According to #1431632-10: Clean up API docs for translation module, @xjm and @jhodgdon have previously stated that 'the word "Boolean" should always be capitalized (because it's derived from the name Boole).'
I am not sure whether this 'boolean' capitalization issue also should be dealt with in this issue or a follow-up issue.
Comment #11
jhodgdonLet's keep this issue targeted.
And you're probably right that this issue should be postponed until after feature freeze, when we'll enter the "cleanup" phase.
Comment #12
lars toomre commentedRelated issue: #1860690: Correct Boolean use in docblocks
Comment #13
rteijeiro commentedHey what's up with all the changes I have done?
So if you want I could keep them in a branch and merge them later or maybe I could do something else.
Comment #14
jhodgdonIf you want to make a patch that omits the vendor files and ArchiveTar, we can revive it or reroll it when it's time to un-postpone this issue in a few weeks. Thanks! And sorry about forgetting we aren't supposed to do massive cleanups before then...
Comment #14.0
jhodgdonUpdated with #1897058-7: Replace "boolean" with "bool" when used as param/return/var type comment
Comment #15
pefferen commentedIll will be working on this issue during the Amsterdam 2014 Sprint.
Comment #16
jhodgdonComment #17
disasm commentedpatch only changing boolean/Boolean to bool in @param/@return/@var.
Comment #18
disasm commentedComment #19
jhodgdonHm. Above I think we decided not to fix the ArchiverTar class, which has many other problems beyond this one.
I'm also not sure about the JS files... let's just do PHP in this patch. I think in some cases Boolean is correct in JS.
The rest looks good. Can you just remove the JS and ArchiverTar parts from this patch? And thanks for reviving the issue!
Comment #20
disasm commentedmade changes requested in #19.
Comment #21
jhodgdonThanks, looks good!
Beta eval: This is docs only.
Comment #22
alexpottDocs are not frozen in beta. Committed 284681a and pushed to 8.0.x. Thanks!