Add units and round results to the minimum significant figures

Boavizta / boaviztapi

🛠 Giving access to BOAVIZTA reference data and methodologies trough a RESTful API

GNU Affero General Public License v3.0

68 stars 23 forks source link

Add units and round results to the minimum significant figures #61

Closed odelcroi closed 2 years ago

odelcroi commented 2 years ago

adding units to impact results as stated in #43
round impacts results to the most appropriate significant figures number as stated in #43 : it is defined by the input values from the user and the values from Boavizta database
device.impact_***() -> (float, int): now returns a raw result without rounding and a precision number to round it if needed. It allows to use the raw result for more calculation

da-ekchajzer commented 2 years ago

Everything looks great, thank you for your PR. I made roundit a service instead of a util because i think it fulfills a business rule. Tell me if your ok with that. If so i will merge to the main branch.

odelcroi commented 2 years ago

Thanks david for your review, I wouldn't say it fullfills a business rule as it is quite generic to the rest of the project. I could have used an external library to round our results to the less significant figures but I didn't find one. I'd prefer to keep roundit considered as a util class, I mean we can replace it in the future without changing the business logic of the project.

da-ekchajzer commented 2 years ago

Ok I agree. I'll put it back into an util class and merge the PR.