Note: This issue is reserved for an intern applicant at MD Systems. Please do not work on this unless assigned to it by us :)

Problem/Motivation

In JobItemInterface, there are some documentations wrongly defined.

  • Interface doc-block:

/**
* Interface for tmgmt_job entity.
*
* @ingroup tmgmt_job
*/

  • setState() @return description:

/**
* Updates the state of the job item.
...

* @return int
* The updated state of the job if it could be set.
...

  • getMessages() doc-block:

/**
* Returns all job messages attached to this ...
...

* @return array
* An array of translation job messages.
*/

  • and getMessagesSince() doc-block:

/**
* Returns all job messages attached to this ...
...

* @return array
* An array of translation job messages.
*/

Proposed resolution

Replace "job" with "job item".

Remaining tasks

User interface changes

API changes

Data model changes

CommentFileSizeAuthor
#6 interdiff-2774755-2-6.txt591 bytestbonomelli
#6 jobiteminterfacce_wrong_documentations-2774755-6.patch1.86 KBtbonomelli
#2 jobiteminterface_wrong_documentations-2774755-2.patch1.84 KBtbonomelli

Comments

tduong created an issue. See original summary.

tbonomelli’s picture

tbonomelli commented
Assigned: Unassigned » tbonomelli
Status: Active » Needs review
StatusFileSize
new jobiteminterface_wrong_documentations-2774755-2.patch1.84 KB

I replaced "job" with "job item" in the listed documentations.

Status: Needs review » Needs work

The last submitted patch, 2: jobiteminterface_wrong_documentations-2774755-2.patch, failed testing.

tduong’s picture

tduong commented
Status: Needs work » Needs review

Retest triggered as locally passes as well.

tduong’s picture

tduong commented
Status: Needs review » Needs work

Ok, test is passing, just a tiny thing:

+++ b/src/JobItemInterface.php
@@ -482,7 +482,7 @@ interface JobItemInterface extends ContentEntityInterface {
+   * Returns all job item messages attached to this job item with timestamp newer

80 chars D: just put 'newer' in the second line :D

Then I think it is alright :)

tbonomelli’s picture

tbonomelli commented
Status: Needs work » Needs review
StatusFileSize
new jobiteminterfacce_wrong_documentations-2774755-6.patch1.86 KB
new interdiff-2774755-2-6.txt591 bytes

Updated the documentation.

tduong’s picture

tduong commented
Status: Needs review » Reviewed & tested by the community

Cool, now it's alright! :)

  • Berdir committed 699bd56 on 8.x-1.x authored by tbonomelli 
    Issue #2774755 by tbonomelli: JobItemInterface wrong documentations
berdir’s picture

berdir
Primary language German
Location Switzerland
commented
Status: Reviewed & tested by the community » Fixed 
+++ b/src/JobItemInterface.php
@@ -5,9 +5,9 @@ namespace Drupal\tmgmt;
  *
- * @ingroup tmgmt_job
+ * @ingroup tmgmt_job_item
  */

There is now tmmgt_job_item group, this is still tmgmt_job.

Fixed and committed.

Status: Fixed » Closed (fixed)

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