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

chore(ci): add codespell, apply spell fixes, and update contributing #767

Merged
merged 1 commit into from
Nov 21, 2023

Conversation

mspronesti
Copy link
Contributor

@mspronesti mspronesti commented Nov 21, 2023

Hi @gventuri,
this "cosmetic" PR introduced codespell as a dev dependency to flag and solve spelling mistakes in the source code, documentation, examples, and tests.
I've thereby updated the contributing docs and the workflows and fixed the typos spotted by codespell.

Summary by CodeRabbit

  • Documentation

    • Added a new section for spell checking in CONTRIBUTING.md.
    • Updated documentation to include the examples directory in linting instructions.
    • Corrected typographical errors in various documentation files and docstrings.
  • Bug Fixes

    • Fixed typographical errors in comments and error messages across multiple files.
  • Tests

    • Corrected typos in test descriptions and mock data.
  • Chores

    • Improved CI workflow with additional linting and spellcheck steps.

Copy link
Contributor

coderabbitai bot commented Nov 21, 2023

Walkthrough

The recent updates across various files in the codebase primarily focus on typo corrections and minor documentation improvements. A new spellcheck step has been added to the CI workflow, and the linting process now includes the examples directory. These changes enhance the readability and maintainability of the code without altering any functionality.

Changes

File(s) Summary
.github/workflows/ci.yml Added spellcheck step and updated linting to include examples directory.
CONTRIBUTING.md, docs/..., examples/..., pandasai/..., tests/... Corrected various typographical errors in documentation, comments, and error messages.
pandasai/pipelines/logic_units/prompt_execution.py Replaced single quotes with double quotes in getattr calls.

🐇 In the code where rabbits hop, 🍂
Typos fall and corrections pop.
With each spellcheck and a lint,
We smooth the code with a gentle hint. 🌟


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

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

@mspronesti mspronesti changed the title chore: add codespell, apply spell fixes, and update contributing chore(ci): add codespell, apply spell fixes, and update contributing Nov 21, 2023
@codecov-commenter
Copy link

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (a61a538) 85.17% compared to head (d7691f1) 85.17%.

Files Patch % Lines
pandasai/pipelines/logic_units/prompt_execution.py 0.00% 2 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #767   +/-   ##
=======================================
  Coverage   85.17%   85.17%           
=======================================
  Files          88       88           
  Lines        3798     3798           
=======================================
  Hits         3235     3235           
  Misses        563      563           

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

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

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between a61a538 and d7691f1.
Files ignored due to filter (2)
  • poetry.lock
  • pyproject.toml
Files selected for processing (21)
  • .github/workflows/ci.yml (1 hunks)
  • CONTRIBUTING.md (1 hunks)
  • docs/building_docs.md (1 hunks)
  • docs/custom-prompts.md (1 hunks)
  • examples/from_sql.py (1 hunks)
  • examples/with_multiple_dataframes.py (1 hunks)
  • pandasai/agent/init.py (1 hunks)
  • pandasai/assets/prompt_templates/current_code.tmpl (1 hunks)
  • pandasai/connectors/airtable.py (1 hunks)
  • pandasai/connectors/sql.py (2 hunks)
  • pandasai/exceptions.py (4 hunks)
  • pandasai/helpers/code_manager.py (2 hunks)
  • pandasai/llm/base.py (1 hunks)
  • pandasai/pipelines/logic_units/prompt_execution.py (1 hunks)
  • pandasai/pipelines/pipeline.py (1 hunks)
  • pandasai/pipelines/smart_datalake_chat/result_parsing.py (1 hunks)
  • pandasai/smart_datalake/init.py (1 hunks)
  • tests/pipelines/smart_datalake/test_code_execution.py (3 hunks)
  • tests/prompts/test_generate_python_code_prompt.py (1 hunks)
  • tests/test_agent.py (1 hunks)
  • tests/test_smartdataframe.py (3 hunks)
Files skipped from review due to trivial changes (20)
  • CONTRIBUTING.md
  • docs/building_docs.md
  • docs/custom-prompts.md
  • examples/from_sql.py
  • examples/with_multiple_dataframes.py
  • pandasai/agent/init.py
  • pandasai/assets/prompt_templates/current_code.tmpl
  • pandasai/connectors/airtable.py
  • pandasai/connectors/sql.py
  • pandasai/exceptions.py
  • pandasai/helpers/code_manager.py
  • pandasai/llm/base.py
  • pandasai/pipelines/logic_units/prompt_execution.py
  • pandasai/pipelines/pipeline.py
  • pandasai/pipelines/smart_datalake_chat/result_parsing.py
  • pandasai/smart_datalake/init.py
  • tests/pipelines/smart_datalake/test_code_execution.py
  • tests/prompts/test_generate_python_code_prompt.py
  • tests/test_agent.py
  • tests/test_smartdataframe.py

.github/workflows/ci.yml Show resolved Hide resolved
.github/workflows/ci.yml Show resolved Hide resolved
@gventuri
Copy link
Collaborator

@mspronesti man one of the most useful PRs of the last few months! Thanks a lot for that, much appreciated!

@gventuri gventuri merged commit abd1538 into Sinaptik-AI:main Nov 21, 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.

3 participants