This is part of the larger issue #1331240: [Meta] Correct documentation for 'list' related issues

This issue contains a larger patch that fixes the 'easy' stuff regarding lists documentation in /includes (H-Z).

The intention of this patch is that it should be easy to review without needing to look at the resulting patched code files. It also designed to only include changes that might be acceptable for backport to D7.

CommentFileSizeAuthor
#4 interdiff-1333538-2-4.txt2.13 KBkrknth
#4 1333538-4.patch6.52 KBkrknth
#2 1333538-1.patch6.44 KBkrknth
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

krknth’s picture

krknth CreditAttribution: krknth as a volunteer and at Valuebound commented
Title: Easy 'Lists' Fixes for Documentation: /includes H-Z » Further cleanup for documentation in core/includes files starting with H-Z
Assigned: Unassigned » krknth
Issue summary: View changes

I'm working on it.

krknth’s picture

krknth CreditAttribution: krknth as a volunteer and at Valuebound commented
Status: Active » Needs review
Issue tags: +rc eligible, +Novice
FileSize
1333538-1.patch6.44 KB

Added patch

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Needs work

Just a note. The original issue that was filed here was intended to fix up the syntax of documentation containing lists. This patch doesn't have anything to do with that problem. But that's probably OK... the patch is mostly good cleanups. A few things to fix:

  1. +++ b/core/includes/install.inc
@@ -639,9 +639,10 @@ function drupal_install_system($install_state) {
- *   The type of file. Can be file (default), dir, or link.
+ *   (optional) The type of file, Can be file, dir, or link.
+ *   Defaults to 'file'.

    The new lines are not punctuated or capitalized correctly. If you want to make the first two sentences into one, use a ; here and lower-case Can. 

  2. +++ b/core/includes/install.inc
@@ -1044,7 +1045,7 @@ function drupal_check_module($module) {
+ *   (optional) Language code (if any), Defaults to 'en'.

    Defaults => defaults 

  3. +++ b/core/includes/theme.inc
@@ -71,11 +71,11 @@
+ *   (optional) A boolean to indicate whether to return the complete theme

    boolean -> Boolean 

  4. +++ b/core/includes/theme.inc
@@ -71,11 +71,11 @@
+ *   functions or inspect it in a debugger. If FALSE, an instance of the

    needs comma before "or". 

  5. +++ b/core/includes/theme.inc
@@ -71,11 +71,11 @@
  *   Drupal\Core\Utility\ThemeRegistry class will be returned, this provides an

    This is a comma splice. The comma before "this" should be a ; instead. 

  6. +++ b/core/includes/theme.inc
@@ -281,9 +281,9 @@ function drupal_find_theme_templates($cache, $extension, $path) {
+ *   (optional) The name of a given theme; defaults to the current theme.

    Can we fix this up? I think we can get rid of the word "given" here.

krknth’s picture

krknth CreditAttribution: krknth as a volunteer and at Valuebound commented
Status: Needs work » Needs review
FileSize
1333538-4.patch6.52 KB
interdiff-1333538-2-4.txt2.13 KB

@jhodgdon :

1,2,3,4,5 : updated.

*   (optional) The name of a given theme; defaults to the current theme.

6) Should be 'The name of a theme' or 'The name of the theme' ?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Closed (won't fix)

This issue is badly scoped according to our current Issue Scope guidelines. As it is a "cleanup misc. standards stuff" issue I am just going to close it as Won't Fix. Please do not make any more patches. Thanks!

See https://www.drupal.org/core/scope for more on this...