Repository navigation
API- und Dokumentationspflege - #4
Merged
Merged
Conversation
NuGet-Abhängigkeit MSTest in GeometryTests.vbproj von 3.11.0 auf 3.11.1 angehoben.
System.Runtime.InteropServices importiert, Assembly-/Dateiversion auf 1.2026.1010.15 erhöht und MSTest in GeometryTests.vbproj auf 4.4.0 aktualisiert.
AssemblyInfo.vb: System.Runtime.InteropServices importiert und Assembly-/Dateiversion auf 1.2026.1010.16 erhöht. GeometryTests.vbproj: MSTest-Paket von 4.4.0 auf 4.5.1 aktualisiert.
Codeanalyse für Geometry- und GeometryTests-Projekt deaktiviert und Assembly-/Dateiversion in AssemblyInfo.vb auf 1.2026.1010.18 angehoben.
Ressourcenbezeichnung String1 in Resources.resx und Resources.Designer.vb durch CheckTriangleInequality ersetzt und die Dreiecksungleichungsprüfung in ThreeDimensional.Prism auf My.Resources.CheckTriangleInequality umgestellt, ohne den deutschen Meldungstext zu ändern.
Benannte Ressourcen-Schlüssel in Resources.resx und Resources.Designer.vb umgestellt und die Frustum-ArgumentExceptions auf die neuen Schlüssel angepasst.
String4 wurde in Resources.resx und Resources.Designer.vb zu CheckParameterBetweenZeroAndOne umbenannt; ThreeDimensional.Cone.vb verwendet für den Parameter t jetzt My.Resources.CheckParameterBetweenZeroAndOne.
String5 wurde in CheckBasesSumPositive umbenannt und in TwoDimensional/Trapezoid.vb für die Prüfung verwendet, wenn die Summe der Grundseiten nicht positiv ist.
String6 wurde in `CheckPolygonNonDegenerate` in `Resources.Designer.vb` und `Resources.resx` umbenannt. Die Fehlermeldung blieb unverändert; `TwoDimensional.Polygon.vb` verwendet bei degenerierten Polygonen nun `My.Resources.CheckPolygonNonDegenerate`.
String7 in den Ressourcen in CheckVerticesMinimumCount umbenannt und die Fehlermeldungen in Polygon.vb sowie RegularPolygon.vb auf My.Resources.CheckVerticesMinimumCount umgestellt.
Markdown-Dokumentation an aktualisierte API-Signaturen angepasst: Parameternamen vereinheitlicht, optionale Toleranzen und Unterteilungen markiert, Vertex-Parameter auf Arrays/Listen umgestellt und Hinweise zu ArgumentException, PointF, numerischen Grenzen sowie Cuboid.IsCube ergänzt.
System.Runtime.InteropServices importiert und AssemblyVersion sowie AssemblyFileVersion von 1.2026.1010.18 auf 1.2026.1010.1 angepasst.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The functional references and documentation match the implemented APIs, with only a minor resource-key naming inconsistency remaining.
1 open finding
What changed in this PR
This PR aligns resource names and documentation with the geometry APIs while updating project configuration.
Changes:
- Replaces generic resource keys with descriptive validation names.
- Corrects API documentation for signatures and optional parameters.
- Updates analysis settings, MSTest, and assembly versions.
| File | Description |
|---|---|
GeometryTests/GeometryTests.vbproj |
Disables Debug analysis and updates MSTest. |
Geometry/Geometry.vbproj |
Disables Debug code analysis. |
Geometry/My Project/AssemblyInfo.vb |
Adjusts assembly versions. |
Geometry/My Project/Resources.resx |
Renames validation resources. |
Geometry/My Project/Resources.Designer.vb |
Updates generated resource properties. |
Geometry/ThreeDimensional/Cone.vb |
Uses the renamed parameter-range resource. |
Geometry/ThreeDimensional/Cuboid.md |
Documents optional cube tolerance. |
Geometry/ThreeDimensional/Frustum.vb |
Uses renamed dimension resources. |
Geometry/ThreeDimensional/Prism.vb |
Uses the renamed triangle resource. |
Geometry/TwoDimensional/Circle.md |
Aligns parameter names and adds methods. |
Geometry/TwoDimensional/Ellipse.md |
Clarifies optional subdivisions and return behavior. |
Geometry/TwoDimensional/Kite.md |
Documents optional tolerances. |
Geometry/TwoDimensional/Parallelogram.md |
Aligns constraints and parameter names. |
Geometry/TwoDimensional/Polygon.md |
Documents optional tolerances. |
Geometry/TwoDimensional/Polygon.vb |
Uses descriptive polygon resources. |
Geometry/TwoDimensional/Rectangle.md |
Aligns signatures and invalid-input behavior. |
Geometry/TwoDimensional/RegularPolygon.md |
Documents optional tolerance. |
Geometry/TwoDimensional/RegularPolygon.vb |
Uses the renamed vertex-count resource. |
Geometry/TwoDimensional/Rhombus.md |
Documents optional tolerance. |
Geometry/TwoDimensional/Square.md |
Documents optional tolerance. |
Geometry/TwoDimensional/Trapezoid.md |
Documents optional tolerances. |
Geometry/TwoDimensional/Trapezoid.vb |
Uses the renamed base-sum resource. |
Geometry/TwoDimensional/Triangle.md |
Aligns vertex-array signatures. |
Files not reviewed (1)
- Geometry/My Project/Resources.Designer.vb: Generated file
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
Resource references, documented signatures, framework compatibility, and affected call sites are consistent with no unresolved defects found.
1 open finding
Files not reviewed (1)
- Geometry/My Project/Resources.Designer.vb: Generated file
🧠 Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Classification
API- und Dokumentationspflege: Ressourcennamen, Validierungsstellen und Methodendokumentation wurden vereinheitlicht, zusätzlich wurden Projekt- und Paketkonfigurationen angepasst.
PR Summary
Die PR ersetzt generische Ressourcenschlüssel durch sprechende Namen und zieht die betroffenen Validierungen in den Geometrieklassen nach. Parallel dazu wurden XML- und Markdown-Dokus an die aktuellen Signaturen, Parameter und Rückgabewerte angepasst.
Geometry/Resources.resxundResources.Designer.vb: Umstellung vonString1bisString7auf sprechende Ressourcenschlüssel.Cone.vb,Frustum.vb,Prism.vb,Polygon.vb,RegularPolygon.vb,Trapezoid.vb: Validierungsfehler auf die neuen Ressourcennamen umgestellt.Circle.md,Ellipse.md,Polygon.md,RegularPolygon.md,Trapezoid.md,Triangle.md,Cuboid.mdu. a.: Parameterbezeichnungen, optionale Toleranzen, Signaturen und Rückgabewerte dokumentationsseitig konsistent aktualisiert.Geometry.vbprojundGeometryTests.vbproj:RunCodeAnalysisdeaktiviert; inGeometryTests.vbprojwurdeMSTestauf4.5.1angehoben.AssemblyInfo.vb: Versionsnummern zurückgesetzt bzw. angepasst.