Repository navigation
Rename the allometry inventory creators to with_gdam_allometry and with_crown_base_height_allometry (breaking) - #253
Merged
Conversation
create_tree_inventory_from_gdam -> create_tree_inventory_with_gdam_allometry create_tree_inventory_from_crown_base_height -> create_tree_inventory_with_crown_base_height_allometry Both take an existing inventory and return the same trees with columns added, so from_ named the wrong thing. The new names follow the API's allometry routes. Breaking: no aliases.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #252.
Renames the two allometry inventory creators. Both take an existing inventory and return the same trees with columns added, so
from_named the wrong thing. The new names follow the API's allometry routes (allometry/gdam,allometry/crown_base_height).create_tree_inventory_from_gdamcreate_tree_inventory_with_gdam_allometrycreate_tree_inventory_from_crown_base_heightcreate_tree_inventory_with_crown_base_height_allometryBreaking: a hard rename with no aliases. Release as 0.26.0.
Updated the functions and
__all__, the docstring cross-references ininventories.pyandgrids.py,docs/v2/guides/inventories.md,v2_api_design.md, and the tests (functions and test class names).Checks
pytest tests/v2/test_inventories.py -k "WithGdamAllometry or WithCrownBaseHeightAllometry or BuildCrownBaseHeightModel"against the live API: 22 passed.Downstream
FastFuels-Web docs call
create_tree_inventory_from_gdamin six files andcreate_tree_inventory_from_crown_base_heighton the upload how-to. A docs PR follows after the release.