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

Improved variable naming and formatting in 'basic_example.py' for enh… #1061

Merged
merged 8 commits into from
Mar 21, 2024

Conversation

MedinavonLevetzow
Copy link
Contributor

The primary objective of this pull request is to offer new users a clearer understanding of the example and improve readability for all.

=> Changed File: 'basic_example.py'

  • Refactored code to streamline by extracting unnecessary steps into dedicated functions, ensuring clarity and focus on the framework's core example.
  • Enhanced variable naming for readability, particularly important for newcomers.
  • Other comments and questions
  • Could you please confirm that the enhanced variable names adequately describe their purpose?
    • Like the BATTERY_STORAGE which was introduced as a constant value, there were several places that just use the String "storage".
  • Any suggestions for changes are welcome

@p-snft p-snft changed the base branch from dev to revision/basic_example March 7, 2024 09:59
Copy link
Member

@p-snft p-snft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @MedinavonLevetzow,

thanks for your valuable proposals. We actually know that the examples are a bit of a weak spot, so I started working on a new tutorial-like example a while ago (#1041). Still, as this one exists, it can really profit from clarifications.

I changed the PR to merge into the existing revision, so that we can ask for a common review of another dev once I approve your changes. (See inline comments.)

Cheers,
Patrik

examples/basic_example/basic_example.py Outdated Show resolved Hide resolved
examples/basic_example/basic_example.py Outdated Show resolved Hide resolved
examples/basic_example/basic_example.py Outdated Show resolved Hide resolved
examples/basic_example/basic_example.py Show resolved Hide resolved
Copy link
Member

@p-snft p-snft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now. Thanks.

@p-snft p-snft merged commit 3f1bb5d into oemof:revision/basic_example Mar 21, 2024
10 checks passed
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.

3 participants