[fix] correct date-time and encrypt-digest function doc issues#3710
Merged
Conversation
date-time-functions: - quarters-add.md: error messages named `month_add` (copy-paste); corrected to `quarters_add`. - sec-to-time.md: the max-seconds bound was written as `3023999`; the actual max for `838:59:59` is `3020399`. - second-ceil.md / second-floor.md: Return Value paragraph used `<date_or_time_expr>` while the params table uses `<datetime>`; unified on `<datetime>`. Also a Chinese link label `[timestamptz的转换]` in the English doc; changed to `[timestamptz conversion]`. - sub-time.md / add-time.md: two of the three relative links in the params row had an extra `../` and a stray literal `docs/` segment; aligned to the sibling link's `../../../../sql-manual/...` form. - time-format.md: a stray closing ``` fence at end of file (after the Note); removed. - timestampadd.md: the second `-- Unit not supported, invalid` example actually triggers an out-of-range error; comment updated to match the error. - timestampdiff.md: Description's MySQL reference pointed at `date_diff`; corrected to `timestampdiff` (function and URL anchor). - to-days.md / unix-timestamp.md / utc-time.md: misaligned result tables; widened/closed borders. utc-time also had a top border missing its leading `+`. - week-floor.md: error label `RROR 1105` was missing its leading `E`. - week.md: the mode-description table was wrapped in a ```sql fence, so it rendered as raw text; fence removed. - week.md / weekday.md / weekofyear.md: the params table used `<datetime_or_date>` while Syntax used `<date_or_time_expr>`; unified on `<date_or_time_expr>`. - weekofyear.md: a sentence said the next week starts on "next Sunday", but the function uses Monday-start weeks; changed to "next Monday". - year-ceil.md / year-floor.md: `<period>` description was "in seconds" / "1 second" (copy-paste from second-ceil); corrected to "years" / "1 year". - weeks-sub.md: error messages named `weeks_add`; corrected to `weeks_sub`. - years-sub.md: error messages named `year_add`; corrected to `years_sub`. - weeks-diff.md / years-diff.md: the `null_input1` / `null_input2` result tables had rulers one character narrower than the cells; widened. - year-ceil.md / year-floor.md: the TimeStampTz result tables had a header row one character shorter than its ruler; padded. encrypt-digest-functions: - aes-encrypt.md: the key-padding paragraph said "less than 16 bits"; the unit elsewhere is bytes; changed to "bytes". - aes-decrypt.md / aes-encrypt.md: frontmatter `description` referenced `AESDECRYPT`/`AESENCRYPT`/`AES128ECB` with no underscores; corrected to `AES_DECRYPT`/`AES_ENCRYPT`/`AES_128_ECB`. - murmur-hash3-32.md: a Note bullet `-Note:` was missing the space after the dash, and the sentence ended with a full-width `。`; corrected to `- Note:` and `.`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes 19 small documentation issues across the date-time and encrypt-digest function references. Each item below is independent.
date-time-functions
out of rangeexamples namedmonth_add(a copy-paste frommonths-add.md); corrected toquarters_add.±3023999; the real max for838:59:59is3020399(838*3600 + 59*60 + 59). Both occurrences corrected.\<date_or_time_expr>`while the parameters table uses``; unified on``. The same files also had a leftover Chinese link label[timestamptz的转换]inside the English doc; replaced with[timestamptz conversion]`.../and a stray literaldocs/segment (../../../../../docs/sql-manual/...); aligned to the sibling link's correct form../../../../sql-manual/....-- Unit not supported, invalidexample actually triggers an out-of-range error, not an unsupported-unit error; the comment is updated to match the actual error.TIMESTAMPDIFF. Function name and URL anchor corrected.utc-time.mdadditionally had a top border missing its leading+.RROR 1105 (HY000):(missing the leadingE); corrected toERROR 1105 (HY000):.yearweek.md).\<datetime_or_date>`while the Syntax used`<date_or_time_expr>`; unified on`<date_or_time_expr>``.<period>description said "how many seconds each period consists of" / "Default is 1 second" (copy-paste from the second-ceil docs); corrected to "years" / "1 year".weeks_addinstead ofweeks_sub; corrected.year_addinstead ofyears_sub; corrected.null_input1/null_input2result tables had rulers one character narrower than the data cells; widened.encrypt-digest-functions
descriptionreferencedAESDECRYPT,AESENCRYPT, andAES128ECBwith no underscores; corrected toAES_DECRYPT,AES_ENCRYPT, andAES_128_ECB.-Note:with no space after the dash and the sentence ended with a full-width。; corrected to- Note:and an ASCII period.Test plan
week.mdmode table no longer rendered as code, link labels)