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

2-liner-exception-messages-fix #3535

Merged
merged 4 commits into from
Jul 1, 2024
Merged

Conversation

KatKatKateryna
Copy link
Contributor

Description & motivation

Changes:

To-do before merge:

Screenshots:

Validation of changes:

Checklist:

  • My pull request follows the guidelines in the Contributing guide?
  • My pull request does not duplicate any other open Pull Requests for the same update/change?
  • My commits are related to the pull request and do not amend unrelated code or documentation.
  • My code follows a similar style to existing code.
  • I have added appropriate tests.
  • I have updated or added relevant documentation.

References

@KatKatKateryna KatKatKateryna changed the title Update FeatureClassUtils.cs 2-liner-exception-messages-fix Jun 26, 2024
@@ -122,7 +122,7 @@ public ACG.GeometryType GetLayerGeometryType(VectorLayer target)
GISLayerGeometryType.POLYLINE => ACG.GeometryType.Polyline,
GISLayerGeometryType.MULTIPATCH => ACG.GeometryType.Multipatch,
GISLayerGeometryType.POLYGON3D => ACG.GeometryType.Multipatch,
_ => throw new ArgumentOutOfRangeException(nameof(target)),
_ => throw new ArgumentOutOfRangeException($"{originalGeomType}"),
Copy link
Member

Choose a reason for hiding this comment

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

What is the first parameter of ArgumentOutOfRangeException is it a message, or is it an argument name?

Copy link
Member

Choose a reason for hiding this comment

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

It looks like it is wanting the parameter name, so nameof(target) was correct no?
You can allways do

new ArgumentOutOfRangeException(nameof(target), "my custom message about what this exception is...");

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmm, true, but parameter name doesn't help the user (e.g. message "System.ArgumentOutOfRangeException: 'Specified argument was out of the range of valid values. (Parameter 'MultiPolygonZ')'" is more helpful than "Parameter 'target' " / "Parameter 'originalGeomType' "

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It can also be $"{nameof(target)} = {originalGeomType}"

Copy link
Contributor

Choose a reason for hiding this comment

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

We have to have info for both so can we include both in the message and use nameof() in the code, it might be a detail but if we're looking at this exception I want to know which thing in the code was out of range. I also don't have the context, so is the argument out of range or invalid?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@BovineOx I eventually added both!

Copy link
Member

@oguzhankoral oguzhankoral left a comment

Choose a reason for hiding this comment

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

I don't have objection, if you say so GTG 🚀

@KatKatKateryna
Copy link
Contributor Author

Thanks @oguzhankoral , now need @JR-Morgan to approve requested changes and unblock merge 🚀

@BovineOx BovineOx removed the request for review from JR-Morgan July 1, 2024 16:29
@BovineOx BovineOx dismissed JR-Morgan’s stale review July 1, 2024 16:31

Jedd is off and we've resolved the concern

@BovineOx BovineOx merged commit b6141ff into dui3/alpha Jul 1, 2024
33 checks passed
@BovineOx BovineOx deleted the 1-liner-exception-message-fix branch July 1, 2024 16:32
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.

4 participants