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

Documentation #582

Merged
merged 50 commits into from
Dec 25, 2024
Merged

Documentation #582

merged 50 commits into from
Dec 25, 2024

Conversation

ikostan
Copy link
Member

@ikostan ikostan commented Dec 25, 2024

Summary by Sourcery

Add documentation for the "Factorial Decomposition" kata.

New Features:

  • Introduce documentation for a new kata in kyu_5.

Documentation:

  • Document the "Factorial Decomposition" kata, including a module, README, and general documentation files.

 Check notice on line 1 in kyu_8/find_the_first_non_consecutive_number/__init__.py

@codacy-production
codacy-production
/ Codacy Static Code Analysis
kyu_8/find_the_first_non_consecutive_number/__init__.py#L1

Final newline missing
@ikostan ikostan added documentation Improvements or additions to documentation codewars Markdown Markdown rules violations labels Dec 25, 2024
@ikostan ikostan self-assigned this Dec 25, 2024
Copy link

sourcery-ai bot commented Dec 25, 2024

Reviewer's Guide by Sourcery

This pull request adds documentation for katas in kyu levels 2 through 8. It also adds documentation specifically for the "factorial decomposition" kata in kyu 5.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added documentation for various katas across kyu levels 2-8.
  • Added documentation files for each kyu level.
docs/kyu_2/kyu_2.rst
docs/kyu_3/kyu_3.rst
docs/kyu_4/kyu_4.rst
docs/kyu_5/kyu_5.rst
docs/kyu_6/kyu_6.rst
docs/kyu_7/kyu_7.rst
docs/kyu_8/kyu_8.rst
Added documentation for the factorial decomposition kata.
  • Created module, readme, and general documentation files for the kata.
docs/kyu_5/kyu_5.factorial_decomposition.module.rst
docs/kyu_5/kyu_5.factorial_decomposition.readme.rst
docs/kyu_5/kyu_5.factorial_decomposition.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ikostan - I've reviewed your changes - here's some feedback:

Overall Comments:

  • PR title should be more descriptive - specify what documentation is being added (e.g. 'Add factorial decomposition documentation to kyu_5')
  • Remove empty diffs for unmodified kyu_* directories to keep the PR focused on actual changes
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codeclimate bot commented Dec 25, 2024

Code Climate has analyzed commit 9692f8a and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 90.4% (0.0% change).

View more on Code Climate.

Copy link

codecov bot commented Dec 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.47%. Comparing base (a10119f) to head (9692f8a).
Report is 51 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #582      +/-   ##
==========================================
- Coverage   90.85%   90.47%   -0.39%     
==========================================
  Files         174      174              
  Lines        2669     2561     -108     
==========================================
- Hits         2425     2317     -108     
  Misses        244      244              

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

checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/codewars/checkouts/582/docs/kyu_2/kyu_2.readme.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/codewars/checkouts/582/docs/kyu_3/kyu_3.readme.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/codewars/checkouts/582/docs/kyu_4/kyu_4.readme.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/codewars/checkouts/582/docs/kyu_5/kyu_5.readme.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/codewars/checkouts/582/docs/kyu_6/kyu_6.readme.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/codewars/checkouts/582/docs/kyu_7/kyu_7.readme.rst: WARNING: document isn't included in any toctree
/home/docs/checkouts/readthedocs.org/user_builds/codewars/checkouts/582/docs/kyu_8/kyu_8.readme.rst: WARNING: document isn't included in any toctree
@ikostan ikostan merged commit 6bd6775 into master Dec 25, 2024
19 of 20 checks passed
ikostan added a commit that referenced this pull request Dec 25, 2024
Merge pull request #582 from iKostanOrg/Documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codewars documentation Improvements or additions to documentation Markdown Markdown rules violations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant