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.

Sign up for GitHub

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

Jump to bottom

[pre-commit.ci] pre-commit autoupdate #38594

Merged
merged 4 commits into from
Jan 16, 2025
Merged

[pre-commit.ci] pre-commit autoupdate #38594

merged 4 commits into from
Jan 16, 2025

Conversation

pre-commit-ci[bot]
Copy link
Contributor

@pre-commit-ci pre-commit-ci bot commented Jan 13, 2025

@github-actions github-actions bot added the Has Conflicts Used by the bot to label pull requests that have conflicts label Jan 15, 2025
@github-actions GitHub Actions
Copy link

👋 Hi, @pre-commit-ci,

Conflicts have been detected against the base branch. Please rebase your branch against the base branch.

@sf1919 sf1919 modified the milestones: Release 6.13, Release 6.12 Jan 15, 2025
@peterfpeterson peterfpeterson force-pushed the pre-commit-ci-update-config branch from b2b8972 to 72aacb6 Compare January 15, 2025 17:26
@peterfpeterson peterfpeterson added Maintenance Unassigned issues to be addressed in the next maintenance period. and removed Has Conflicts Used by the bot to label pull requests that have conflicts labels Jan 15, 2025
@sf1919 sf1919 self-assigned this Jan 16, 2025
sf1919
sf1919 approved these changes Jan 16, 2025
View reviewed changes
Copy link
Contributor

@sf1919 sf1919 left a comment

Choose a reason for hiding this comment

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

I have reviewed by eye all the changes made by pre-commit and @peterfpeterson . These all look to be formatting changes rather than any functional changes e.g. conjoining sentences, removing unneccessary whitespace etc. The tests all passed so I am going to approve this PR.

However on running pre-commit run --all-files (as per #38566 discussion) I found an additional file that needed changes. I have pushed this as a commit seeing as we're so close to code freeze. I don't think this will change any functionality so am still approving. Please can whoever @mantidproject/gatekeepers this one pay attention to my commit and whether any tests fail?

@robertapplin robertapplin self-assigned this Jan 16, 2025
robertapplin
robertapplin previously requested changes Jan 16, 2025
View reviewed changes
Copy link
Contributor

@robertapplin robertapplin left a comment

Choose a reason for hiding this comment

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

It took a while, but managed to read through all the files 😓 The majority of the formatting changes look good, I just spotted a couple things I thought I'd flag

Framework/PythonInterface/plugins/algorithms/BASISCrystalDiffraction.py
)
# Reciprocal vector orthogonal to VectorU and in-plane with
# incoming beam
self.declareProperty(
FloatArrayProperty("VectorV", [0, 1, 0], array_length_three, direction=Direction.Input),
doc="three item, comma-separated, HKL indexes" "of the direction perpendicular to VectorV" "and the vertical axis",
doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorVand the vertical axis",
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
doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorVand the vertical axis",
doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorV and the vertical axis",

Framework/PythonInterface/plugins/algorithms/BASISDiffraction.py
)
# Reciprocal vector orthogonal to VectorU and in-plane with
# incoming beam
self.declareProperty(
FloatArrayProperty("VectorV", [0, 1, 0], array_length_three, direction=Direction.Input),
doc="three item, comma-separated, HKL indexes" "of the direction perpendicular to VectorV" "and the vertical axis",
doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorVand the vertical axis",
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
doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorVand the vertical axis",
doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorV and the vertical axis",

Framework/PythonInterface/plugins/algorithms/FindGoniometerFromUB.py
@@ -100,7 +100,7 @@ def PyInit(self):
defaultValue=0.0,
direction=Direction.Input,
validator=FloatBoundedValidator(lower=0.0, upper=180.0),
doc="omega rotation between component of goniometer axis in XY-plane from +ve Y-axis" "(perpendicular to ki)",
doc="omega rotation between component of goniometer axis in XY-plane from +ve Y-axis(perpendicular to ki)",
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
doc="omega rotation between component of goniometer axis in XY-plane from +ve Y-axis(perpendicular to ki)",
doc="omega rotation between component of goniometer axis in XY-plane from +ve Y-axis (perpendicular to ki)",

Framework/PythonInterface/plugins/algorithms/LoadNMoldyn4Ascii1D.py
@@ -28,7 +28,7 @@ def category(self):
return "Simulation; Inelastic\\DataHandling"

def summary(self):
return "Imports 1D dos and vac functions from an nMolDyn 4 output file," "convoluting it with a resolution function if required."
return "Imports 1D dos and vac functions from an nMolDyn 4 output file,convoluting it with a resolution function if required."
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
return "Imports 1D dos and vac functions from an nMolDyn 4 output file,convoluting it with a resolution function if required."
return "Imports 1D dos and vac functions from an nMolDyn 4 output file, convoluting it with a resolution function if required."

Framework/PythonInterface/plugins/algorithms/PoldiMerge.py
@@ -38,7 +38,7 @@ def PyInit(self):
self.declareProperty(
"CheckInstruments",
True,
"If checked, only workspaces with equal" "instrument parameters are merged." "Do not disable without a very good reason.",
"If checked, only workspaces with equal instrument parameters are merged.Do not disable without a very good reason.",
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
"If checked, only workspaces with equal instrument parameters are merged.Do not disable without a very good reason.",
"If checked, only workspaces with equal instrument parameters are merged. Do not disable without a very good reason.",

Framework/PythonInterface/plugins/algorithms/ElasticEMUauReduction.py
@@ -175,7 +173,7 @@ def PyInit(self) -> None:
self.declareProperty(
name="KeepIntermediateWorkspaces",
defaultValue=False,
doc="Whether to keep the intermediate sample and calibration\n" "workspaces for diagnostic checks.",
doc="Whether to keep the intermediate sample and calibration\nworkspaces for diagnostic checks.",
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
doc="Whether to keep the intermediate sample and calibration\nworkspaces for diagnostic checks.",
doc="Whether to keep the intermediate sample and calibration workspaces for diagnostic checks.",

Framework/PythonInterface/plugins/algorithms/ElasticEMUauReduction.py
)

self.declareProperty(
name="SteppedScanParameter",
defaultValue=False,
doc="If the environment variable is set and held\n" "during each scan rather than continuosly changing.",
doc="If the environment variable is set and held\nduring each scan rather than continuosly changing.",
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
doc="If the environment variable is set and held\nduring each scan rather than continuosly changing.",
doc="If the environment variable is set and held during each scan rather than continuosly changing.",

Framework/PythonInterface/plugins/algorithms/ElasticEMUauReduction.py
doc="Normalise the sample counts over the environment or\n"
"time range. Values are in environment units or secs,\n"
" eg 75-100",
doc="Normalise the sample counts over the environment or\ntime range. Values are in environment units or secs,\n eg 75-100",
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
doc="Normalise the sample counts over the environment or\ntime range. Values are in environment units or secs,\n eg 75-100",
doc="Normalise the sample counts over the environment or time range. Values are in environment units or secs,\n eg 75-100",

Framework/PythonInterface/plugins/algorithms/ElasticEMUauReduction.py
@@ -148,21 +148,19 @@ def PyInit(self) -> None:
self.declareProperty(
name="ScanParameter",
defaultValue="",
doc="Display data for time series environment variable,\n" "using optional label and units" " eg T02SP06 [, Temperature, K]",
doc="Display data for time series environment variable,\nusing optional label and units eg T02SP06 [, Temperature, K]",
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
doc="Display data for time series environment variable,\nusing optional label and units eg T02SP06 [, Temperature, K]",
doc="Display data for time series environment variable, using optional label and units eg T02SP06 [, Temperature, K]",

Framework/PythonInterface/plugins/algorithms/ElasticEMUauReduction.py
@@ -97,7 +97,7 @@ def PyInit(self) -> None:
mandatoryInputRuns.add(StringArrayMandatoryValidator())
self.declareProperty(
StringArrayProperty("SampleRuns", values=[], validator=mandatoryInputRuns),
doc="Comma separated range of sample runs,\n" "and optional dataset indexes,\n" " eg [cycle::] 7333-7341,7345[:0-23]",
doc="Comma separated range of sample runs,\nand optional dataset indexes,\neg [cycle::] 7333-7341,7345[:0-23]",
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
doc="Comma separated range of sample runs,\nand optional dataset indexes,\neg [cycle::] 7333-7341,7345[:0-23]",
doc="Comma separated range of sample runs, and optional dataset indexes, eg [cycle::] 7333-7341,7345[:0-23]",

@robertapplin
Copy link
Contributor

A lot of the formatting issues (involving missing spaces) are not regressions, and already existed in the code. Its been decided to merge this PR now and fix the highlighted formatting problems in a separate PR

This is so we can merge this PR before creating the release-next branch due to code freeze

@robertapplin robertapplin enabled auto-merge (squash) January 16, 2025 10:52
@robertapplin robertapplin mentioned this pull request Jan 16, 2025
Open
@robertapplin
Copy link
Contributor

Opened a maintenance issue here #38610

@robertapplin robertapplin dismissed their stale review January 16, 2025 11:01

Will be done in separate PR

@robertapplin robertapplin merged commit 99b307a into main Jan 16, 2025
10 checks passed
@robertapplin robertapplin deleted the pre-commit-ci-update-config branch January 16, 2025 11:01
@peterfpeterson peterfpeterson mentioned this pull request Jan 16, 2025
Merged
sf1919 added a commit that referenced this pull request Jan 17, 2025
@sf1919
Fix formatting issues spotted when reviewing #38594
9afccda
@sf1919 sf1919 mentioned this pull request Jan 17, 2025
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sf1919 sf1919 sf1919 approved these changes

@robertapplin robertapplin robertapplin left review comments

Assignees

@robertapplin robertapplin

@sf1919 sf1919

Labels
Maintenance Unassigned issues to be addressed in the next maintenance period.
Projects
None yet
Milestone
Release 6.12
Development

Successfully merging this pull request may close these issues.
3 participants
@robertapplin @sf1919 @peterfpeterson