8000 docs: gmt info by dstala · Pull Request #8002 · nocodb/nocodb · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: gmt info #8002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 29, 2024
Merged

docs: gmt info #8002

merged 1 commit into from
Mar 29, 2024

Conversation

dstala
Copy link
Member
@dstala dstala commented Mar 28, 2024

Change Summary

Provide summary of changes with issue number if any.

Change type

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Test/ Verification

Provide summary of changes.

Additional information / screenshots (optional)

Anything for maintainers to be made aware of

Summary by CodeRabbit

  • Documentation
    • Added notes on timezone impact for DAY, MONTH, and HOUR functions in the formula documentation, clarifying that returned values are based on the server's timezone.
< 8000 include-fragment loading="lazy" src="/nocodb/nocodb/issues/8002/edit_form?textarea_id=issue-2213386103-body&comment_context=" data-nonce="v2:862ecdaa-64f8-a3d8-7ffc-d6b0590c52ae" data-view-component="true" class="previewable-comment-form js-comment-edit-form-deferred-include-fragment">

Copy link
Contributor
coderabbitai bot commented Mar 28, 2024
Walkthrough

Walkthrough

The recent update focuses on enhancing the documentation for date functions, specifically DAY, MONTH, and HOUR by incorporating notes about how timezone differences can affect their returned values. These notes aim to clarify that the calculations are based on the server's timezone, which is GMT by default, and highlight potential discrepancies when the browser's timezone differs.

Changes

File Path Change Summary
.../formula/040.date-functions.md Added notes on timezone impact for DAY, MONTH, and HOUR functions, clarifying that values are based on server's timezone (GMT by default) and may differ if browser timezone differs.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5109746 and 8facb98.
Files selected for processing (1)
  • packages/noco-docs/docs/070.fields/040.field-types/060.formula/040.date-functions.md (3 hunks)
Additional comments (2)
packages/noco-docs/docs/070.fields/040.field-types/060.formula/040.date-functions.md (2)
  • 131-131: The note added to the DAY function documentation is clear and effectively communicates the impact of the server's timezone on the returned value. This addition enhances the documentation's clarity and usability.
  • 150-150: The note added to the MONTH function documentation is clear and effectively communicates the impact of the server's timezone on the returned value. This addition enhances the documentation's clarity and usability.

@@ -165,7 +165,7 @@ HOUR('2022-03-14 12:00:00') => 12
```

#### Remark
This function returns the hour of the day as an integer between 0 and 23 (inclusive).
This function returns the hour of the day as an integer between 0 and 23 (inclusive). Hour information retrieved is based on a 24-hour clock & will be based on the timezone of the server (GMT by default). Note that, if browser timezone is different from the server timezone, the hour value may differ.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The note added to the HOUR function documentation effectively communicates the impact of the server's timezone on the returned value. However, to improve grammatical correctness, consider adding an article before "browser timezone".

- Note that, if browser timezone is different from the server timezone, the hour value may differ.
+ Note that, if the browser timezone is different from the server timezone, the hour value may differ.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
This function returns the hour of the day as an integer between 0 and 23 (inclusive). Hour information retrieved is based on a 24-hour clock & will be based on the timezone of the server (GMT by default). Note that, if browser timezone is different from the server timezone, the hour value may differ.
This function returns the hour of the day as an integer between 0 and 23 (inclusive). Hour information retrieved is based on a 24-hour clock & will be based on the timezone of the server (GMT by default). Note that, if the browser timezone is different from the server timezone, the hour value may differ.

@dstala dstala merged commit 6d1bf1e into develop Mar 29, 2024
@dstala dstala deleted the nc-docs/gmt-info branch March 29, 2024 02:27
6700 Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0