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: rename custom opt. dep-s docfile (#581) #582

Merged

Conversation

nautics889
Copy link
Contributor

@nautics889 nautics889 commented Sep 20, 2023

Minor fixes in documentation files for #581.


  • (fix): link for custom-whitelisted-dependencies.md now works as it suppose to be
  • (chore): update mkdocs.yml with a new filename

Summary by CodeRabbit

  • Refactor: Renamed "Custom optional dependencies" to "Custom whitelisted dependencies" across the codebase for improved clarity.
  • Documentation: Updated custom-whitelisted-dependencies.md to explain the new terminology and usage. Users can now add custom modules to the whitelist by passing them to the custom_whitelisted_dependencies parameter when creating instances of SmartDataframe or SmartDatalake.

* (fix): link for custom-whitelisted-dependencies.md now works as it
  suppose to be
* (chore): update mkdocs.yml with a new filename
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 20, 2023

Walkthrough

This change refines the terminology in our codebase, replacing "Custom optional dependencies" with "Custom whitelisted dependencies". It also provides clear instructions on how to add custom modules to the whitelist when using SmartDataframe or SmartDatalake classes.

Changes

File Summary
docs/custom-whitelisted-dependencies.md The terminology has been updated from "Custom optional dependencies" to "Custom whitelisted dependencies". Instructions have been added for adding custom modules to the whitelist.

🐇🎉

In the land of code where the shadows lie,

We refine our words, under the digital sky.

From optional to whitelist, a leap so grand,

Making our intentions clear, easy to understand.

So celebrate this change, hop and twirl,

For it makes clearer our digital world! 🌍💻🎊


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • Mention @coderabbitai in any review comment for bot assistance.
  • Note: Review comments are made on code diffs or files, not on the PR overview.

Pause Incremental Reviews

  • Insert @coderabbitai: ignore in the PR description to halt the bot's ongoing reviews. Remove the line to resume.

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: 0

Commits Files that changed from the base of the PR and between 7738feb and 8130175.
Files ignored due to filter (1)
  • mkdocs.yml
Files selected for processing (1)
  • docs/custom-whitelisted-dependencies.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/custom-whitelisted-dependencies.md

@gventuri gventuri merged commit 58a18cb into Sinaptik-AI:main Sep 20, 2023
9 checks passed
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.

Missing custom-whitelisted-dependencies.md
2 participants