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.

Sign up for GitHub

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

Jump to bottom

Improve API documentation in CompositeBase #1968

Merged
merged 3 commits into from Jan 18, 2022
Merged

Improve API documentation in CompositeBase #1968

merged 3 commits into from Jan 18, 2022

Commits on Jan 7, 2022

  1. Improve API documentation in CompositeBase 

    Improve the API documentation in CompositeBase.  Correct the spelling of
the NEGLIGIBLE_COORDS module attribute (keeping the old NEGLIBLE_COORDS
in place for backward compatibility purposes).

Mark check_areas as deprecated in the docstring.
    @gerritholl
    gerritholl committed Jan 7, 2022
    Copy the full SHA
    f5c45a7 View commit details
    Browse the repository at this point in the history

  2. Remove NEGLIBLE_COORDS attribute and check_areas method 

    Remove the misspelt and hopefully externally unused NEGLIBLE_COORDS module
attribute, and remove the check_areas method that had been deprecated
for a while.
    @gerritholl
    gerritholl committed Jan 7, 2022
    Copy the full SHA
    347a435 View commit details
    Browse the repository at this point in the history

  3. Point out that CompositeBase is also for modifiers 

    In the docstring of CompositeBase, point out that all modifier classes
/also/ derive from CompositeBase.
    @gerritholl
    gerritholl committed Jan 7, 2022
    Copy the full SHA
    7cc9443 View commit details
    Browse the repository at this point in the history