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

Change EventHeader to EventHeaderName #240

Merged
merged 1 commit into from
Nov 14, 2023
Merged

Change EventHeader to EventHeaderName #240

merged 1 commit into from
Nov 14, 2023

Conversation

jmcarcell
Copy link
Member

@jmcarcell jmcarcell commented Nov 14, 2023

BEGINRELEASENOTES

  • Change EventHeader to EventHeaderName; we already have an EventHeaderCollection and its elements are called EventHeader (edm4hep::EventHeader more precisely)

ENDRELEASENOTES

Building can work because there is edm4hep::EventHeader and the constant is not namespaced but it's going to break at some point, at the very least you can't do things like using edm4hep::EventHeader.

@jmcarcell jmcarcell requested a review from Zehvogel November 14, 2023 13:35
Copy link
Contributor

@Zehvogel Zehvogel left a comment

Choose a reason for hiding this comment

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

😩

@@ -21,7 +21,7 @@

namespace edm4hep {
static constexpr const char* CellIDEncoding = "CellIDEncoding";
static constexpr const char* EventHeader = "EventHeader";
static constexpr const char* EventHeaderName = "EventHeader";
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
static constexpr const char* EventHeaderName = "EventHeader";
static constexpr const char* eventHeader = "EventHeader";

As a "less-typing necessary" variant? Or maybe EvtHeader?

Copy link
Contributor

Choose a reason for hiding this comment

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

I would prefer clarity over shortness

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm all for typing less 🤓 but in this case a mistake from eventHeader to EventHeader can even make the code compile and have some problems somewhere else and EvtHeader is also quite similar. I was going to say let Leonhard decide, but he beat me to it so it's two votes against one. I checked the CI failure and I'm quite sure it's not transient, but it's unrelated. I'll have a look and try to fix it

@jmcarcell jmcarcell merged commit 808792f into main Nov 14, 2023
14 of 17 checks passed
@jmcarcell jmcarcell deleted the event-header branch November 14, 2023 15:23
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