Skip to content

doc: clean headers to be compatible with reuse annotate#93

Merged
tgilon merged 11 commits intomasterfrom
ci/reuse-clean-headers
Sep 22, 2025
Merged

doc: clean headers to be compatible with reuse annotate#93
tgilon merged 11 commits intomasterfrom
ci/reuse-clean-headers

Conversation

@tgilon
Copy link
Copy Markdown
Member

@tgilon tgilon commented Aug 6, 2025 •
edited by daniel-rdt
Loading

Changes proposed in this Pull Request

Builds on the test in #92. This PR standardises and cleans up headers to make them compatible with reuse annotate. Some attributions have also been adjusted.

Open Todos:

  • Merge master into PR once new features are merged there
  • Double check newly introduced files for compatible headers (e.g. hydro inflow PR)

Checklist

  • I tested my contribution locally and it works as intended.
  • Code and workflow changes are sufficiently documented.
  • Changed dependencies are added to envs/environment.yaml.
  • Changes in configuration options are added in config/config.default.yaml.
  • Changes in configuration options are documented in doc/configtables/*.csv.
  • Changes in configuration options are added in config/test/*.yaml.
  • OET license identifier is added to all edited or newly created code files.
  • Sources of newly added data are documented in doc/data_sources.rst.
  • A release note doc/release_notes.rst is added.
  • Major features are listed in README and doc/index.rst.

@tgilon tgilon self-assigned this Aug 6, 2025
@tgilon tgilon mentioned this pull request Aug 6, 2025
Closed
10 tasks
@tgilon tgilon requested a review from coroa August 6, 2025 07:57
@tgilon tgilon marked this pull request as ready for review August 6, 2025 07:57
@coroa
Copy link
Copy Markdown
Member

coroa commented Aug 6, 2025

Why the preference for single-line comments?

coroa
coroa reviewed Aug 6, 2025
View reviewed changes
Comment thread .gitignore
@tgilon
Copy link
Copy Markdown
Member Author

tgilon commented Aug 6, 2025

Why the preference for single-line comments?

Because reuse annotate uses single-line comments for RST (doc). We could use a custom template, but it is easier to fix the headers. I am considering contributing it upstream as well to reduce the diff.

This was referenced Aug 6, 2025
Closed
Merged
@tgilon
Copy link
Copy Markdown
Member Author

tgilon commented Sep 2, 2025

@daniel-rdt Since #77 is merged, could you please check the newly introduced headers?

@daniel-rdt daniel-rdt requested a review from coroa September 2, 2025 08:39
@tgilon tgilon requested a review from euronion September 9, 2025 14:07
@tgilon
Copy link
Copy Markdown
Member Author

tgilon commented Sep 9, 2025

Hi @euronion , Would you have the time to review this PR?

euronion
euronion approved these changes Sep 17, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@euronion euronion left a comment

Choose a reason for hiding this comment

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

LGTM

@euronion
Copy link
Copy Markdown
Member

euronion commented Sep 17, 2025

Why the preference for single-line comments?

Because reuse annotate uses single-line comments for RST (doc). We could use a custom template, but it is easier to fix the headers. I am considering contributing it upstream as well to reduce the diff.

Contributing this change upstream would be great! If this is what reuse does, then I'm not sure why it is different in PyPSA-Eur atm.

@tgilon tgilon mentioned this pull request Sep 22, 2025
Merged
7 tasks
@tgilon
Copy link
Copy Markdown
Member Author

tgilon commented Sep 22, 2025

Contributing this change upstream would be great! If this is what reuse does, then I'm not sure why it is different in PyPSA-Eur atm.

Done PyPSA#1839

@tgilon tgilon merged commit e8a223a into master Sep 22, 2025
5 of 6 checks passed
@tgilon tgilon deleted the ci/reuse-clean-headers branch September 22, 2025 18:25
@daniel-rdt daniel-rdt mentioned this pull request Oct 27, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@euronion euronion euronion approved these changes

@coroa coroa Awaiting requested review from coroa

Assignees

@tgilon tgilon

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@tgilon @coroa @euronion @daniel-rdt