Problem/Motivation

#2057809: Correct the @param and @return statements on dbtng has been committed and only @param and @return statements were included, to limit patch size.
This issue will focus on @var, @see and @throws statements, as I already worked on them in the previous one.

#2057809: Correct the @param and @return statements on dbtng

Patch is coming.

CommentFileSizeAuthor
#1 var_see_throws-2064261-1.patch20.71 KBstephaneq

Comments

stephaneq’s picture

stephaneq
Primary language French
Location Paris 🇫🇷
commented
Status: Active » Needs review
StatusFileSize
new var_see_throws-2064261-1.patch20.71 KB
dawehner’s picture

dawehner
Primary language German
commented
Status: Needs review » Reviewed & tested by the community 
@@ -981,10 +981,10 @@ public function pushTransaction($name) {
+   * @throws \Drupal\Core\Database\TransactionNoActiveException
+   * @throws \Drupal\Core\Database\TransactionCommitFailedException

In general I kinda like if something describes why a certain exception is thrown , but that is maybe out of scope... but I don't block this issue upon that.

dries’s picture

dries commented
Status: Reviewed & tested by the community » Fixed

Committed to 8.x. Thanks.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

@dawehner - regarding @throws, the current standard is that if the exception class name doesn't tell everything we would need to know, then there should be explanations starting on the next line.

In most/all of the cases in this patch, I think the class names are pretty much self-explanatory, but definitely if you think more information is needed, that can be added.

Status: Fixed » Closed (fixed)

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