JSDoc for block_content module.

See parent issue for details.

CommentFileSizeAuthor
#8 jsdoc_block_content-2503985-8.patch1.7 KBeiriksm
#3 jsdoc_block_content-2503985-3.patch1.45 KBeiriksm
#1 jsdoc_block_content-2503985-1.patch1.24 KBeiriksm

Comments

eiriksm’s picture

eiriksm
he/him
Primary language Norwegian Bokmål
Location Norway
commented
Status: Active » Needs review
StatusFileSize
new jsdoc_block_content-2503985-1.patch1.24 KB

Just some reformatting for 80 character lines.

nod_’s picture

nod_
Primary language French
Location Lille
commented
Status: Needs review » Needs work

Wouldn't mind having a description for the behavior too.

eiriksm’s picture

eiriksm
he/him
Primary language Norwegian Bokmål
Location Norway
commented
Status: Needs work » Needs review
StatusFileSize
new jsdoc_block_content-2503985-3.patch1.45 KB

Good point.

nod_’s picture

nod_
Primary language French
Location Lille
commented
Status: Needs review » Reviewed & tested by the community

works for me, thanks :)

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 3: jsdoc_block_content-2503985-3.patch, failed testing.

nod_’s picture

nod_
Primary language French
Location Lille
commented
Status: Needs work » Reviewed & tested by the community
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Needs work

Thanks!

I applied this patch and looked at block_content.js. There are some additional things that I think need to be fixed:

  1. Drupal.behaviors.blockContentDetailsSummaries doc block does not have any docs in it (one line summary needed at a minimum).
  2. The attach function does not have a doc block at all.
eiriksm’s picture

eiriksm
he/him
Primary language Norwegian Bokmål
Location Norway
commented
Status: Needs work » Needs review
StatusFileSize
new jsdoc_block_content-2503985-8.patch1.7 KB

Drupal.behaviors.blockContentDetailsSummaries doc block does not have any docs in it (one line summary needed at a minimum).

Sorry if I misunderstand, but it does have a one line summary already, no? Or are you talking about something else?

Anyway, here is an updated patch with behavior docs added. Since the patch is still small i did not make an interdiff, but the only thing changed is the @prop behaviour part.

If I misunderstood your point 1, I'll be glad to fix it up of course, but I am not sure I see something missing there.

nod_’s picture

nod_
Primary language French
Location Lille
commented
Status: Needs review » Reviewed & tested by the community

Applies and latest patch fixes #7

  • webchick committed b165014 on 8.0.x 
    Issue #2503985 by eiriksm, nod_, jhodgdon: JSDoc block_content module
webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Status: Reviewed & tested by the community » Fixed

Committed and pushed to 8.0.x. Thanks!

Status: Fixed » Closed (fixed)

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