From dd3b1f3aed395b2595b591ee1fc1f6eac617fb7b Mon Sep 17 00:00:00 2001 From: dudaodong Date: Tue, 22 Mar 2022 14:10:58 +0800 Subject: [PATCH] docs: add doc for some new funcs --- README.md | 12 ++++++++++++ README_zh-CN.md | 12 ++++++++++++ docs/datetime.md | 1 + 3 files changed, 25 insertions(+) diff --git a/README.md b/README.md index c680e9f..ae8521f 100644 --- a/README.md +++ b/README.md @@ -175,6 +175,14 @@ import "github.com/duke-git/lancet/v2/datetime" - [GetNightTimestamp](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#GetNightTimestamp) - [FormatTimeToStr](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#FormatTimeToStr) - [FormatStrToTime](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#FormatStrToTime) +- [NewUnix](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#NewUnix) +- [NewUnixNow](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#NewUnixNow) +- [NewFormat](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#NewFormat) +- [NewISO8601](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#NewISO8601) +- [ToUnix](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToUnix) +- [ToFormat](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToFormat) +- [ToFormatForTpl](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToFormatForTpl) +- [ToIso8601](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToIso8601) ### Fileutil package implements some basic functions for file operations. @@ -230,9 +238,12 @@ import "github.com/duke-git/lancet/v2/mathutil" ``` #### Function list: +- [Average](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Average) - [Exponent](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Exponent) - [Fibonacci](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Fibonacci) - [Factorial](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Factorial) +- [Max](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Max) +- [Min](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Min) - [Percent](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Percent) - [RoundToFloat](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#RoundToFloat) - [RoundToString](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#RoundToString) @@ -309,6 +320,7 @@ import "github.com/duke-git/lancet/v2/slice" - [FlattenDeep](#FlattenDeep) - [ForEach](https://github.com/duke-git/lancet/blob/main/docs/slice.md#ForEach) - [GroupBy](https://github.com/duke-git/lancet/blob/main/docs/slice.md#GroupBy) +- [GroupWith](https://github.com/duke-git/lancet/blob/main/docs/slice.md#GroupWith) - [IntSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#IntSlice) - [InterfaceSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#InterfaceSlice) - [Intersection](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Intersection) diff --git a/README_zh-CN.md b/README_zh-CN.md index d8593c5..23769db 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -174,6 +174,14 @@ import "github.com/duke-git/lancet/v2/datetime" - [GetNightTimestamp](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#GetNightTimestamp) - [FormatTimeToStr](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#FormatTimeToStr) - [FormatStrToTime](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#FormatStrToTime) +- [NewUnix](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#NewUnix) +- [NewUnixNow](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#NewUnixNow) +- [NewFormat](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#NewFormat) +- [NewISO8601](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#NewISO8601) +- [ToUnix](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToUnix) +- [ToFormat](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToFormat) +- [ToFormatForTpl](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToFormatForTpl) +- [ToIso8601](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToIso8601) ### fileutil包支持文件基本操作。 @@ -229,9 +237,12 @@ import "github.com/duke-git/lancet/v2/mathutil" ``` #### Function list: +- [Average](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Average) - [Exponent](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Exponent) - [Fibonacci](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Fibonacci) - [Factorial](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Factorial) +- [Max](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Max) +- [Min](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Min) - [Percent](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Percent) - [RoundToFloat](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#RoundToFloat) - [RoundToString](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#RoundToString) @@ -307,6 +318,7 @@ import "github.com/duke-git/lancet/v2/slice" - [FlattenDeep](#FlattenDeep) - [ForEach](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#ForEach) - [GroupBy](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#GroupBy) +- [GroupWith](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#GroupWith) - [IntSlice](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#IntSlice) - [InterfaceSlice](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#InterfaceSlice) - [Intersection](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Intersection) diff --git a/docs/datetime.md b/docs/datetime.md index 7fcac69..d8274a4 100644 --- a/docs/datetime.md +++ b/docs/datetime.md @@ -6,6 +6,7 @@ Package datetime supports date and time format and compare. ## Source: - [https://github.com/duke-git/lancet/blob/main/datetime/datetime.go](https://github.com/duke-git/lancet/blob/main/datetime/datetime.go) +- [https://github.com/duke-git/lancet/blob/main/datetime/conversion.go](https://github.com/duke-git/lancet/blob/main/datetime/conversion.go)