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

Enhancements to Fluid Handling Module #61

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Adriel007
Copy link

Summary of Changes

This pull request introduces several enhancements to the fluid handling module:

  • Documentation: Added comprehensive docstrings to functions and classes for better understanding and usage.
  • Type Annotations: Included type annotations to improve code clarity and maintainability.
  • Fluid Alias Consolidation: Organized fluid aliases into a dictionary structure, enhancing readability and ease of maintenance.
  • Simplified Logic: Streamlined the logic in the normalize_mix function to make it more intuitive and efficient.
  • Improved Error Handling: Enhanced error handling in the get_fluid_name function to provide informative messages when a fluid name is not found.

These improvements aim to elevate the readability, maintainability, and robustness of the fluid handling module specifically for Petrobras applications.

- *Docstrings*: Added docstrings to functions and classes to explain their purpose and usage.
- *Type Annotations*: Added type annotations to function parameters and return values for better clarity.
- *Consistent Naming*: Used consistent naming conventions throughout the code.
- *Fluid Aliases*: Consolidated the aliases for each fluid into a dictionary for better readability and maintenance.
- *Simplified Logic*: Simplified the logic in the normalize_mix function to make it more straightforward.
- *Error Handling*: Improved error handling in the get_fluid_name function to raise informative errors when the fluid name is not found.

These improvements enhance the readability, maintainability, and robustness of code.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant