You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by GitBox <gi...@apache.org> on 2022/06/28 16:07:18 UTC

[GitHub] [dolphinscheduler] sneh-wha opened a new pull request, #10659: Modified parameter doc files.

sneh-wha opened a new pull request, #10659:
URL: https://github.com/apache/dolphinscheduler/pull/10659

   <!--Thanks very much for contributing to Apache DolphinScheduler. Please review https://dolphinscheduler.apache.org/en-us/community/development/pull-request.html before opening a pull request.-->
   
   
   ## Purpose of the pull request
   
   <!--(For example: This pull request adds checkstyle plugin).-->
   
   ## Brief change log
   
   <!--*(for example:)*
     - *Add maven-checkstyle-plugin to root pom.xml*
   -->
   ## Verify this pull request
   
   <!--*(Please pick either of the following options)*-->
   
   This pull request is code cleanup without any test coverage.
   
   *(or)*
   
   This pull request is already covered by existing tests, such as *(please describe tests)*.
   
   (or)
   
   This change added tests and can be verified as follows:
   
   <!--*(example:)*
     - *Added dolphinscheduler-dao tests for end-to-end.*
     - *Added CronUtilsTest to verify the change.*
     - *Manually verified the change by testing locally.* -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [dolphinscheduler] zhongjiajie commented on a diff in pull request #10659: Modified parameter doc files.

Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on code in PR #10659:
URL: https://github.com/apache/dolphinscheduler/pull/10659#discussion_r909229324


##########
docs/docs/en/guide/parameter/built-in.md:
##########
@@ -2,47 +2,33 @@
 
 ## Basic Built-in Parameter
 
-<table>
-    <tr><th>Variable</th><th>Declaration Method</th><th>Meaning</th></tr>
-    <tr>
-        <td>system.biz.date</td>
-        <td>${system.biz.date}</td>
-        <td>The day before the schedule time of the daily scheduling instance, the format is yyyyMMdd</td>
-    </tr>
-    <tr>
-        <td>system.biz.curdate</td>
-        <td>${system.biz.curdate}</td>
-        <td>The schedule time of the daily scheduling instance, the format is yyyyMMdd</td>
-    </tr>
-    <tr>
-        <td>system.datetime</td>
-        <td>${system.datetime}</td>
-        <td>The schedule time of the daily scheduling instance, the format is yyyyMMddHHmmss</td>
-    </tr>
-</table>
+| Variable | Declaration Method | Meaning |
+| ---- | ---- | -----------------------------| 
+| system.biz.date | ${system.biz.date} | The day before the schedule time of the daily scheduling instance, the format is yyyyMMdd |
+| system.biz.curdate | ${system.biz.curdate} | The schedule time of the daily scheduling instance, the format is yyyyMMdd |
+| system.datetime | ${system.datetime} | The schedule time of the daily scheduling instance, the format is yyyyMMddHHmmss |

Review Comment:
   ```suggestion
   | system.biz.date | `${system.biz.date}` | The day before the schedule time of the daily scheduling instance, the format is `yyyyMMdd` |
   | system.biz.curdate | `${system.biz.curdate}` | The schedule time of the daily scheduling instance, the format is `yyyyMMdd` |
   | system.datetime | `${system.datetime}` | The schedule time of the daily scheduling instance, the format is `yyyyMMddHHmmss` |
   ```



##########
docs/docs/en/guide/parameter/built-in.md:
##########
@@ -2,47 +2,33 @@
 
 ## Basic Built-in Parameter
 
-<table>
-    <tr><th>Variable</th><th>Declaration Method</th><th>Meaning</th></tr>
-    <tr>
-        <td>system.biz.date</td>
-        <td>${system.biz.date}</td>
-        <td>The day before the schedule time of the daily scheduling instance, the format is yyyyMMdd</td>
-    </tr>
-    <tr>
-        <td>system.biz.curdate</td>
-        <td>${system.biz.curdate}</td>
-        <td>The schedule time of the daily scheduling instance, the format is yyyyMMdd</td>
-    </tr>
-    <tr>
-        <td>system.datetime</td>
-        <td>${system.datetime}</td>
-        <td>The schedule time of the daily scheduling instance, the format is yyyyMMddHHmmss</td>
-    </tr>
-</table>
+| Variable | Declaration Method | Meaning |
+| ---- | ---- | -----------------------------| 
+| system.biz.date | ${system.biz.date} | The day before the schedule time of the daily scheduling instance, the format is yyyyMMdd |
+| system.biz.curdate | ${system.biz.curdate} | The schedule time of the daily scheduling instance, the format is yyyyMMdd |
+| system.datetime | ${system.datetime} | The schedule time of the daily scheduling instance, the format is yyyyMMddHHmmss |
 
 ## Extended Built-in Parameter
 
 - Support custom variables in the code, declaration way: `${variable name}`. Refers to "System Parameter".
 
 - Benchmark variable defines as `$[...]` format, time format `$[yyyyMMddHHmmss]` can be decomposed and combined arbitrarily, such as: `$[yyyyMMdd]`, `$[HHmmss]`, `$[yyyy-MM-dd]`, etc.
 
-- Or define by the 2 following ways:
+- Or define by the following two ways:
 
-      1. Use add_month(yyyyMMdd, offset) function to add or minus number of months
-      the first parameter of this function is [yyyyMMdd], represents the time format
-      the second parameter is offset, represents the number of months the user wants to add or minus
-      * Next N years:$[add_months(yyyyMMdd,12*N)]
-      * N years before:$[add_months(yyyyMMdd,-12*N)]
-      * Next N months:$[add_months(yyyyMMdd,N)]
-      * N months before:$[add_months(yyyyMMdd,-N)]
-      *********************************************************************************************************
-      1. Add or minus numbers directly after the time format
-      * Next N weeks:$[yyyyMMdd+7*N]
-      * First N weeks:$[yyyyMMdd-7*N]
-      * Next N days:$[yyyyMMdd+N]
-      * N days before:$[yyyyMMdd-N]
-      * Next N hours:$[HHmmss+N/24]
-      * First N hours:$[HHmmss-N/24]
-      * Next N minutes:$[HHmmss+N/24/60]
-      * First N minutes:$[HHmmss-N/24/60]
\ No newline at end of file
+    1. Use add_month(yyyyMMdd, offset) function to add or minus number of months.
+      The first parameter of this function is [yyyyMMdd], represents the time format and the second parameter is offset, represents the number of months the user wants to add or minus.
+        - Next N years:$[add_months(yyyyMMdd,12*N)]
+       - N years before:$[add_months(yyyyMMdd,-12*N)]
+       - Next N months:$[add_months(yyyyMMdd,N)]
+        - N months before:$[add_months(yyyyMMdd,-N)]

Review Comment:
   ```suggestion
           - Next N years:`$[add_months(yyyyMMdd,12*N)]`
           - N years before:`$[add_months(yyyyMMdd,-12*N)]`
           - Next N months:`$[add_months(yyyyMMdd,N)]`
           - N months before:`$[add_months(yyyyMMdd,-N)]`
   ```



##########
docs/docs/en/guide/parameter/built-in.md:
##########
@@ -2,47 +2,33 @@
 
 ## Basic Built-in Parameter
 
-<table>
-    <tr><th>Variable</th><th>Declaration Method</th><th>Meaning</th></tr>
-    <tr>
-        <td>system.biz.date</td>
-        <td>${system.biz.date}</td>
-        <td>The day before the schedule time of the daily scheduling instance, the format is yyyyMMdd</td>
-    </tr>
-    <tr>
-        <td>system.biz.curdate</td>
-        <td>${system.biz.curdate}</td>
-        <td>The schedule time of the daily scheduling instance, the format is yyyyMMdd</td>
-    </tr>
-    <tr>
-        <td>system.datetime</td>
-        <td>${system.datetime}</td>
-        <td>The schedule time of the daily scheduling instance, the format is yyyyMMddHHmmss</td>
-    </tr>
-</table>
+| Variable | Declaration Method | Meaning |
+| ---- | ---- | -----------------------------| 
+| system.biz.date | ${system.biz.date} | The day before the schedule time of the daily scheduling instance, the format is yyyyMMdd |
+| system.biz.curdate | ${system.biz.curdate} | The schedule time of the daily scheduling instance, the format is yyyyMMdd |
+| system.datetime | ${system.datetime} | The schedule time of the daily scheduling instance, the format is yyyyMMddHHmmss |
 
 ## Extended Built-in Parameter
 
 - Support custom variables in the code, declaration way: `${variable name}`. Refers to "System Parameter".
 
 - Benchmark variable defines as `$[...]` format, time format `$[yyyyMMddHHmmss]` can be decomposed and combined arbitrarily, such as: `$[yyyyMMdd]`, `$[HHmmss]`, `$[yyyy-MM-dd]`, etc.
 
-- Or define by the 2 following ways:
+- Or define by the following two ways:
 
-      1. Use add_month(yyyyMMdd, offset) function to add or minus number of months
-      the first parameter of this function is [yyyyMMdd], represents the time format
-      the second parameter is offset, represents the number of months the user wants to add or minus
-      * Next N years:$[add_months(yyyyMMdd,12*N)]
-      * N years before:$[add_months(yyyyMMdd,-12*N)]
-      * Next N months:$[add_months(yyyyMMdd,N)]
-      * N months before:$[add_months(yyyyMMdd,-N)]
-      *********************************************************************************************************
-      1. Add or minus numbers directly after the time format
-      * Next N weeks:$[yyyyMMdd+7*N]
-      * First N weeks:$[yyyyMMdd-7*N]
-      * Next N days:$[yyyyMMdd+N]
-      * N days before:$[yyyyMMdd-N]
-      * Next N hours:$[HHmmss+N/24]
-      * First N hours:$[HHmmss-N/24]
-      * Next N minutes:$[HHmmss+N/24/60]
-      * First N minutes:$[HHmmss-N/24/60]
\ No newline at end of file
+    1. Use add_month(yyyyMMdd, offset) function to add or minus number of months.
+      The first parameter of this function is [yyyyMMdd], represents the time format and the second parameter is offset, represents the number of months the user wants to add or minus.
+        - Next N years:$[add_months(yyyyMMdd,12*N)]
+       - N years before:$[add_months(yyyyMMdd,-12*N)]
+       - Next N months:$[add_months(yyyyMMdd,N)]
+        - N months before:$[add_months(yyyyMMdd,-N)]
+      
+    2. Add or minus numbers directly after the time format.
+       - Next N weeks:$[yyyyMMdd+7*N]
+       - First N weeks:$[yyyyMMdd-7*N]
+       - Next N days:$[yyyyMMdd+N]
+       - N days before:$[yyyyMMdd-N]
+       - Next N hours:$[HHmmss+N/24]
+       - First N hours:$[HHmmss-N/24]
+       - Next N minutes:$[HHmmss+N/24/60]
+       - First N minutes:$[HHmmss-N/24/60]

Review Comment:
   ```suggestion
          - Next N weeks:`$[yyyyMMdd+7*N]`
          - First N weeks:`$[yyyyMMdd-7*N]`
          - Next N days:`$[yyyyMMdd+N]`
          - N days before:`$[yyyyMMdd-N]`
          - Next N hours:`$[HHmmss+N/24]`
          - First N hours:`$[HHmmss-N/24]`
          - Next N minutes:`$[HHmmss+N/24/60]`
          - First N minutes:`$[HHmmss-N/24/60]`
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [dolphinscheduler] zhongjiajie merged pull request #10659: Modified parameter doc files.

Posted by GitBox <gi...@apache.org>.
zhongjiajie merged PR #10659:
URL: https://github.com/apache/dolphinscheduler/pull/10659


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org