API page: https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Database%...

The Schema class in \Drupal\Core\Database has no doc block. It should.

Also the @file doc block does not conform to our standards:
https://www.drupal.org/node/1354#file

Beta phase: This is just API docs.

CommentFileSizeAuthor
#6 interdiff-6.txt346 bytesjoshi.rohit100
#6 database_schema_doc-10031785-6.patch651 bytesjoshi.rohit100
#5 interdiff.txt343 bytespguillard
#5 database_schema_doc-10031785-5.patch650 bytespguillard
#2 database_schema_doc-10031785-2.patch648 bytespguillard

Comments

pguillard’s picture

pguillard commented
Assigned: Unassigned » pguillard
pguillard’s picture

pguillard commented
Status: Active » Needs review
StatusFileSize
new database_schema_doc-10031785-2.patch648 bytes

A really small first patch.
In fact many Drupal\Core\Database classes are not documented..

pguillard’s picture

pguillard commented
Assigned: pguillard » Unassigned
cilefen’s picture

cilefen commented

@pguillard Good job. Something to note:

+++ b/core/lib/Drupal/Core/Database/Schema.php
@@ -2,7 +2,7 @@
- * Definition of Drupal\Core\Database\Schema
+ * Defines Drupal\Core\Database\Schema

This should be "Contains Drupal\..." and must have a period at the end.

pguillard’s picture

pguillard commented
StatusFileSize
new database_schema_doc-10031785-5.patch650 bytes
new interdiff.txt343 bytes

Thanks @cilefen

joshi.rohit100’s picture

joshi.rohit100
he/him
Primary language Hindi
Location Delhi, India
commented
StatusFileSize
new database_schema_doc-10031785-6.patch651 bytes
new interdiff-6.txt346 bytes

Slightly minor change.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes
Status: Needs review » Reviewed & tested by the community
Issue tags: +Quick fix

Looks fine to me, thanks!

Beta phase: This is just API docs.

The last submitted patch, 2: database_schema_doc-10031785-2.patch, failed testing.

The last submitted patch, 5: database_schema_doc-10031785-5.patch, failed testing.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 6: database_schema_doc-10031785-6.patch, failed testing.

zaurav’s picture

zaurav
Primary language English
Location Oakton, VA
commented
Status: Needs work » Reviewed & tested by the community

RTBC because the patches address the problem outlined in the issue and conform to coding standards.

1. The Schema class has been provided with a docblock style comment.
2. The @file docblock has been edited to conform with standards.
3. Follows all standards in General considerations for API module parsing and Drupal API documentation standards (general)

zaurav queued 6: database_schema_doc-10031785-6.patch for re-testing.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 6: database_schema_doc-10031785-6.patch, failed testing.

dylanf queued 6: database_schema_doc-10031785-6.patch for re-testing.

dylf’s picture

dylf commented
Status: Needs work » Reviewed & tested by the community

Testbot is working!

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 6: database_schema_doc-10031785-6.patch, failed testing.

The last submitted patch, 6: database_schema_doc-10031785-6.patch, failed testing.

pguillard queued 6: database_schema_doc-10031785-6.patch for re-testing.

jhodgdon’s picture

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

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Fixed

Committed c65b82f and pushed to 8.0.x. Thanks!

  • alexpott committed c65b82f on 8.0.x 
    Issue #2506655 by pguillard, joshi.rohit100: Database Schema class has...

Status: Fixed » Closed (fixed)

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