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

Replace "identifer" with "identifier" in docs and code #10026

Merged
merged 2 commits into from Nov 1, 2023

Conversation

bencomp
Copy link
Contributor

@bencomp bencomp commented Oct 18, 2023

What this PR does / why we need it:
Fix a typo across the documentation and codebase: identifer becomes identifier.

Which issue(s) this PR closes:

Closes #7138

Special notes for your reviewer:
In case outside code somehow relies on the old spelling of public method names with typos, I created a copy and marked it as deprecated. Sonarlint then wants a Javadoc comment about the deprecation, so I added that too.
When I fixed the typo in a logging statement that performed string concatenation, I replaced the call with a different method that uses string formatting – a code optimisation.

Suggestions on how to test this: nothing special.

Does this PR introduce a user interface change? If mockups are available, please link/include them here: no

Is there a release notes update needed for this change?: no

Additional documentation: no

Just in case code outside this project is referencing the old methods,
I created deprecated versions.
@pdurbin
Copy link
Member

pdurbin commented Oct 19, 2023

I really wish Jenkins tests were passing. That's this issue:

Meanwhile, I kicked off a run here: https://github.com/gdcc/api-test-runner/actions/runs/6569210124

@bencomp
Copy link
Contributor Author

bencomp commented Oct 19, 2023

Thanks, @pdurbin. That test run failed, but I don't think it's my fault – I didn't touch FilesIT or the code that it calls.

@pdurbin
Copy link
Member

pdurbin commented Oct 19, 2023

@bencomp oh! You can see logs from https://github.com/gdcc/api-test-runner/actions/runs/6569210124 ?!? That's great! @lubitchv can you see them?

Related issue:

@lubitchv
Copy link
Contributor

Yes, In manual.yml I clicked api and could see that it failed on "FilesIT.testDeleteFile:2002 1 expectation failed."

@pdurbin pdurbin added this to Ready for Review ⏩ in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) via automation Oct 19, 2023
@pdurbin pdurbin added the Size: 3 A percentage of a sprint. 2.1 hours. label Oct 19, 2023
@pdurbin
Copy link
Member

pdurbin commented Oct 19, 2023

@lubitchv that's great news!

@pdurbin
Copy link
Member

pdurbin commented Oct 19, 2023

@bencomp I moved this to Ready for Review. We talked about it at standup just now.

@pdurbin
Copy link
Member

pdurbin commented Oct 19, 2023

I kicked off another run: https://github.com/gdcc/api-test-runner/actions/runs/6578559376

I do agree that the changes shouldn't be breaking any tests.

@bencomp
Copy link
Contributor Author

bencomp commented Oct 19, 2023

It passed 🎉

@pdurbin
Copy link
Member

pdurbin commented Oct 19, 2023

Sure did! Great. I think I'll let someone else take a look before we send this to QA. No standup tomorrow but I'll try to remember to mention it on Monday if someone hasn't picked it up by then.

Copy link
Member

@qqmyers qqmyers 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!

IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from Ready for Review ⏩ to Ready for QA ⏩ Oct 30, 2023
@landreev landreev merged commit 87c0f64 into IQSS:develop Nov 1, 2023
10 of 11 checks passed
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from QA ✅ to Done 🚀 Nov 1, 2023
@pdurbin pdurbin added this to the 6.1 milestone Nov 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Size: 3 A percentage of a sprint. 2.1 hours.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Code Clean Up - Correct "identifer" Typo
5 participants