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

Improve mapping doc examples about enumerations usage #180

Merged
merged 4 commits into from
Nov 18, 2024

Conversation

jeandemanged
Copy link
Member

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem?

No

What kind of change does this PR introduce?

Docs update

What is the current behavior?

Documentation lacks some details about enumerations usage e.g. when filtering on IIDM Country or EnergySource.

What is the new behavior (if this is a feature change)?
Added the relevant enum imports for the examples. Also fixed some formatting issues here and there.

Does this PR introduce a breaking change or deprecate an API?

  • No

Other information:

Issue reported via slack discussion

Signed-off-by: Damien Jeandemange <damien.jeandemange@artelys.com>
@jeandemanged jeandemanged added the documentation Improvements or additions to documentation label Nov 7, 2024
Copy link
Member

@rolnico rolnico left a comment

Choose a reason for hiding this comment

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

LGTM

@rolnico rolnico merged commit 871792b into main Nov 18, 2024
13 checks passed
@rolnico rolnico deleted the doc-filter-country-examples branch November 18, 2024 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants