doc: update document for datetime package

release v2.1.7
2026-03-01 00:35:28 +08:00 · 2022-10-14 10:20:38 +08:00 · 2022-10-14 10:08:43 +08:00
4 changed files with 8 additions and 8 deletions
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
 <br/>

 ![Go version](https://img.shields.io/badge/go-%3E%3Dv1.18-9cf)
-[![Release](https://img.shields.io/badge/release-2.1.6-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.1.7-green.svg)](https://github.com/duke-git/lancet/releases)
 [![GoDoc](https://godoc.org/github.com/duke-git/lancet/v2?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet/v2)
 [![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet/v2)](https://goreportcard.com/report/github.com/duke-git/lancet/v2)
 [![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -4,7 +4,7 @@
 <br/>

 ![Go version](https://img.shields.io/badge/go-%3E%3Dv1.18-9cf)
-[![Release](https://img.shields.io/badge/release-2.1.6-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.1.7-green.svg)](https://github.com/duke-git/lancet/releases)
 [![GoDoc](https://godoc.org/github.com/duke-git/lancet/v2?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet/v2)
 [![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet/v2)](https://goreportcard.com/report/github.com/duke-git/lancet/v2)
 [![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
--- a/docs/datetime.md
+++ b/docs/datetime.md
@@ -251,7 +251,7 @@ func main() {
 <b>Signature:</b>

 ```go
-func BeginOfWeek(t time.Time) time.Time
+func BeginOfWeek(t time.Time, beginFrom ...time.Weekday) time.Time
 ```
 <b>Example:</b>

@@ -414,7 +414,7 @@ func main() {
 <b>Signature:</b>

 ```go
-func EndOfWeek(t time.Time) time.Time
+func EndOfWeek(t time.Time, endWith ...time.Weekday) time.Time
 ```
 <b>Example:</b>

--- a/docs/datetime_zh-CN.md
+++ b/docs/datetime_zh-CN.md
@@ -243,12 +243,12 @@ func main() {


 ### <span id="BeginOfWeek">BeginOfWeek</span>
-<p>返回指定时间的星期开始时间</p>
+<p>返回指定时间的每周开始时间,默认开始时间星期日</p>

 <b>函数签名:</b>

 ```go
-func BeginOfWeek(t time.Time) time.Time
+func BeginOfWeek(t time.Time, beginFrom ...time.Weekday) time.Time
 ```
 <b>例子:</b>

@@ -406,12 +406,12 @@ func main() {


 ### <span id="EndOfWeek">EndOfWeek</span>
-<p>返回指定时间的星期结束时间</p>
+<p>返回指定时间的星期结束时间,默认结束时间星期六</p>

 <b>函数签名:</b>

 ```go
-func EndOfWeek(t time.Time) time.Time
+func EndOfWeek(t time.Time, endWith ...time.Weekday) time.Time
 ```
 <b>例子:</b>
Author	SHA1	Message	Date
dudaodong	1ccf0af2b3	doc: update document for datetime package	2022-10-14 10:20:38 +08:00
dudaodong	6314889c6a	release v2.1.7	2022-10-14 10:08:43 +08:00