As for this documentation http://drupal.org/node/1354#param-return-data-type and #1892472: Document hook_block_access we should:

- Replace all references to "boolean" and "Boolean" by "bool" in "@var", "@param" and "@return" directives.
- Replace all references to "Array" by "array" in "@var", "@param" and "@return" directives.
- Replace all references to "integer" and "Integer" by "int" in "@var", "@param" and "@return" directives.
- Replace leading slash before these three directives for strings like '@param Drupal\' and '@param Symphony'.
- A global clean up of 'Contains ' replacing 'Definition of ' in the core class files.

Comments

jhodgdon’s picture

Issue tags: +Novice

Probably a good Novice project.

rteijeiro’s picture

pcambra I am working on it ;)

rteijeiro’s picture

Assigned: Unassigned » rteijeiro
rteijeiro’s picture

Status: Active » Needs review
StatusFileSize
new93.01 KB

Also replaced "@var boolean" declarations.

Attached complete patch. Hope it's right.

droplet’s picture

Status: Needs review » Needs work

exclude 3rd party scripts ?

+++ b/core/vendor/doctrine/common/lib/Doctrine/Common/EventManager.phpundefined
--- a/core/vendor/doctrine/common/lib/Doctrine/Common/Lexer.php
+++ b/core/vendor/doctrine/common/lib/Doctrine/Common/Lexer.phpundefined

+++ b/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Request.phpundefined
--- a/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Resources/stubs/SessionHandlerInterface.php
+++ b/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Resources/stubs/SessionHandlerInterface.phpundefined
tstoeckler’s picture

Despite not living in core/vendor ArchiveTar is also an external file and should be excluded as well.

lars toomre’s picture

I 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.

rteijeiro’s picture

Title: Replace "boolean" in documentation » Basic house-cleaning documentation

Updating issue title

jhodgdon’s picture

Title: Basic house-cleaning documentation » Replace "boolean" with "bool" when used as param/return/var type

Let'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).

lars toomre’s picture

A 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.

jhodgdon’s picture

Status: Needs work » Postponed

Let'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.

lars toomre’s picture

rteijeiro’s picture

Hey 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.

jhodgdon’s picture

If 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...

jhodgdon’s picture

pefferen’s picture

Issue summary: View changes
Issue tags: +Amsterdam2014

Ill will be working on this issue during the Amsterdam 2014 Sprint.

jhodgdon’s picture

Status: Postponed » Active
disasm’s picture

Status: Active » Needs review
StatusFileSize
new24.18 KB

patch only changing boolean/Boolean to bool in @param/@return/@var.

disasm’s picture

Assigned: rteijeiro » disasm
jhodgdon’s picture

Status: Needs review » Needs work

Hm. 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!

disasm’s picture

Status: Needs work » Needs review
StatusFileSize
new18.39 KB
new5.79 KB

made changes requested in #19.

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Thanks, looks good!

Beta eval: This is docs only.

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Docs are not frozen in beta. Committed 284681a and pushed to 8.0.x. Thanks!

  • alexpott committed 284681a on 8.0.x
    Issue #1897058 by disasm, rteijeiro: Replace "boolean" with "bool" when...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.