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

fixed other references to incorrect method name #1033

Merged
merged 2 commits into from
Feb 27, 2025

Conversation

rekumar
Copy link
Contributor

@rekumar rekumar commented Feb 26, 2025

Summary

I fixed the code examples in the quickstart docs

Major changes:

  • fix: There was a typo in the quickstart docs for the Builder code that did not raise an error but also rendered the example incorrect. The example subclass of Builder implemented a method .process_items instead of the correct method .process_item, resulting in no processing being applied. Hopefully this can save others some headache when getting started :)

Checklist

  • [na] Google format doc strings added.
  • [na] Code linted with ruff. (For guidance in fixing rule violates, see rule list)
  • [na] Type annotations included. Check with mypy.
  • [na] Tests added for new features/fixes.
  • [ na] I have run the tests locally and they passed.

Tip: Install pre-commit hooks to auto-check types and linting before every commit:

pip install -U pre-commit
pre-commit install

…as miswritten as process_items -- example didnt yield an error but also didnt work properly!
@rkingsbury rkingsbury added the docs documentation label Feb 27, 2025
@rkingsbury
Copy link
Collaborator

Thanks for catching, and fixing, @rekumar !

@rkingsbury rkingsbury merged commit c6769f4 into materialsproject:main Feb 27, 2025
8 checks passed
Copy link

codecov bot commented Feb 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.91%. Comparing base (7c4f066) to head (369accd).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1033   +/-   ##
=======================================
  Coverage   88.91%   88.91%           
=======================================
  Files          46       46           
  Lines        3997     3997           
=======================================
  Hits         3554     3554           
  Misses        443      443           

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants