API page: https://api.drupal.org/api/drupal/core%21modules%21views%21views.api.php...

This page has some somewhat minor issues that need to be fixed:

a) The "Implement hooks" bullet item has a link to the hooks topic, but the link actually goes to the Views class instead. It should say @link views_hooks Views hook topic @endlink.

b) Typos:
ingration (should be integration)

c) Probably the \Drupal\views\Views class needs to be in an @see.

d) It would also probably help if all of the topics that are linked from this page had @ingroup views_overview in their docs header. This would make them list on this page as "sub-topics".

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

kunalgrover05’s picture

kunalgrover05’s picture

Assigned: Unassigned » kunalgrover05
Status: Active » Needs review

Status: Needs review » Needs work
kunalgrover05’s picture

Status: Needs work » Needs review
FileSize
2.26 KB
jhodgdon’s picture

Status: Needs review » Needs work

Thanks! This is pretty good, but it needs a little work:

a) Sorry for not being clear in the issue summary item (d). This one does not belong in the patch:

+++ b/core/modules/system/entity.api.php
@@ -237,6 +237,7 @@
 
 /**
  * @defgroup entity_api Entity API
+ * @ingroup views_overview

We actually only want the views-related topics to be listed as "sub-topics". So we should have the @ingroup lines in:
https://api.drupal.org/api/drupal/core!modules!views!views.api.php/group...
https://api.drupal.org/api/drupal/core!modules!views!views.theme.inc/gro...
https://api.drupal.org/api/drupal/core!modules!views!views.api.php/group...

b) Also when you make these links, @ingroup should go at the *end* of documentation blocks, not at the beginning. See https://www.drupal.org/coding-standards/docs#order

c) I made a mistake in the issue summary, and:

- *   See the @link Views hooks topic @endlink for a list.
+ *   See the @link views_hooks Views hook topic @endlink for a list.

Should say "Views hooks topic" not "Views hooks topic". My bad!

d)

+ * @see \Drupal\views\Views class

Take the word "class" off the end of this line.

e) It looks like the Views Plugins topic is missing the @{. Can you add it? So here:

 /**
  * @defgroup views_plugins Views plugins
+ * @ingroup views_overview
  * Overview of views plugins

It should end up looking like this:

/**
 * @defgroup views_plugins Views plugins
 * @{
 * Overview of views plugins

See https://www.drupal.org/coding-standards/docs#defgroup for details on syntax. It might need a @} at the end also. I am not sure why this is working at all really!

kunalgrover05’s picture

Status: Needs work » Needs review
FileSize
2.64 KB
jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Excellent! Looks perfect now. Thanks very much for the fast work and both patches.

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Documentation is not frozen in beta. Committed 69c9962 and pushed to 8.0.x. Thanks!

  • alexpott committed 69c9962 on 8.0.x
    Issue #2455099 by kunalgrover05: Views overview topic page has some...

Status: Fixed » Closed (fixed)

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