Skip to content
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

docs: fix the link of symlink #488

Merged
merged 1 commit into from
Aug 28, 2024
Merged

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Aug 28, 2024

Summary by CodeRabbit

  • Documentation
    • Updated documentation to clarify the handling of local directory accessibility in the Local job execution context, ensuring users understand to disable symlink options when local directories are not accessible.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Copy link
Contributor

coderabbitai bot commented Aug 28, 2024

Walkthrough

Walkthrough

The documentation has been updated to clarify the behavior of the Local job execution context. The reference to SSHContext has been changed to LocalContext in the instructions regarding local directory accessibility. Users are now advised to disable the symlink option for LocalContext when the local directory is inaccessible, ensuring that files are copied to the remote directory instead of being symlinked.

Changes

Files Change Summary
doc/context.md Updated references from SSHContext to LocalContext for clarity on local directory handling. No changes to exported or public entity declarations.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f6072fe and ed3c8ab.

Files selected for processing (1)
  • doc/context.md (1 hunks)
Additional context used
LanguageTool
doc/context.md

[style] ~20-~20: Consider using “inaccessible” to avoid wordiness.
Context: ... jobs finish. If the local directory is not accessible with the batch system, tu...

(NOT_ABLE_PREMIUM)


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 testing code 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 testing code 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 testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Aug 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.80%. Comparing base (f6072fe) to head (ed3c8ab).
Report is 9 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (f6072fe) and HEAD (ed3c8ab). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (f6072fe) HEAD (ed3c8ab)
15 14
Additional details and impacted files
@@             Coverage Diff             @@
##           master     #488       +/-   ##
===========================================
- Coverage   60.25%   47.80%   -12.45%     
===========================================
  Files          39       39               
  Lines        3857     3857               
===========================================
- Hits         2324     1844      -480     
- Misses       1533     2013      +480     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@njzjz njzjz merged commit 39846ae into deepmodeling:master Aug 28, 2024
26 checks passed
@njzjz njzjz deleted the docs-symlink branch August 28, 2024 22:56
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.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
doc/context.md (1)

20-20: Consider using "inaccessible" for conciseness.

The sentence can be made more concise by using "inaccessible" instead of "not accessible."

- If the local directory is not accessible with the [batch system](./batch.md), turn off {dargs:argument}`symlink <machine[LocalContext]/remote_profile/symlink>`, and then files on the local directory will be copied to the remote directory.
+ If the local directory is inaccessible with the [batch system](./batch.md), turn off {dargs:argument}`symlink <machine[LocalContext]/remote_profile/symlink>`, and then files on the local directory will be copied to the remote directory.
Tools
LanguageTool

[style] ~20-~20: Consider using “inaccessible” to avoid wordiness.
Context: ... jobs finish. If the local directory is not accessible with the batch system, tu...

(NOT_ABLE_PREMIUM)

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.

1 participant