Skip to content

Fix descriptions for various #3528

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
Open
wants to merge 16 commits into
base: develop
Choose a base branch
from
Open

Fix descriptions for various #3528

wants to merge 16 commits into from

Conversation

peterjamesnugent
Copy link
Member

Issues addressed by this PR

Closes #3527

Test files

By inspection.

Changelog

  • Updated descriptions for various projects across BHoM_Engine.

Additional comments

@peterjamesnugent
Analytical_Engine: Fix XML documentation spelling and grammar errors
ada79d4 
- Fix 'perimiter' to 'perimeter' in SetOutlineElements1D.cs
- Fix 'perimiter' to 'perimeter' in OutlineElements1D.cs
- Fix 'Perimiter' to 'Perimeter' in Geometry.cs
- Fix 'outmatic' to 'automatic' in Geometry.cs
- Fix 'trianglular' to 'triangular' in IsOutlineTrianglular.cs
@peterjamesnugent
BHoM_Engine: Fix XML documentation spelling and grammar errors
b3e85ef 
- Fix 'atempts' to 'attempts' in ExtensionMethodToCall.cs
- Fix 'transdiciplinary' to 'transdisciplinary' in ExtensionMethodToCall.cs
- Fix 'GroupSimilarVectorsWithTolerance' to 'groupedVectors' in ExtensionMethodToCall.cs
@peterjamesnugent
Data_Engine: Fix XML documentation spelling and grammar errors
261a471 
- Fix 'atempts' to 'attempts' in Node.cs
- Fix 'atempts' to 'attempts' in ValuesAbove.cs
@peterjamesnugent
Environment_Engine: Fix XML documentation spelling and grammar errors
e90d949 
- Fix 'atempts' to 'attempts' in ThirdOrderPolynomial.cs
- Fix 'atempts' to 'attempts' in FilterPanels.cs
- Fix 'atempts' to 'attempts' in IsCoPlanar.cs
@peterjamesnugent
Facade_Engine: Fix XML documentation spelling and grammar errors
2752862 
- Add missing full stop in FrameGeometry2D.cs Description attribute
@peterjamesnugent
Geometry_Engine: Fix XML documentation spelling and grammar errors
3942cd3 
- Fix 'atempts' to 'attempts' in Plane.cs
@peterjamesnugent
Graphics_Engine: Fix XML documentation spelling and grammar errors
e831fca 
- Fix 'BoudingBox' to 'BoundingBox' in Bounds.cs
- Fix 'the its' to 'its' in Bounds.cs
- Fix 'spacified' to 'specified' in Color.cs
- Fix 'Coverts' to 'Converts' in ToSteppedGradient.cs
@peterjamesnugent
Library_Engine: Fix XML documentation spelling and grammar errors
86c863d 
- Fix 'atempts' to 'attempts' in ValidatePath.cs
@peterjamesnugent
Matter_Engine: Fix XML documentation spelling and grammar errors
f5b6ff7 
- Fix 'transdiciplinary' to 'transdisciplinary' in MappedGeneralMaterialTakeoff.cs
- Fix 'transdiciplinary' to 'transdisciplinary' in MappedMaterialComposition.cs
- Fix 'transdiciplinary' to 'transdisciplinary' in MappedVolumetricMaterialTakeoff.cs
@peterjamesnugent
Reflection_Engine: Fix XML documentation spelling and grammar errors
3a4b3ed 
- Fix 'ParamaterInfo' to 'ParameterInfo' in Description.cs
@peterjamesnugent
Serialiser_Engine: Fix XML documentation spelling and grammar errors
1215723 
- Fix 'recomended' to 'recommended' in Deserialise.cs
- Fix 'recomended' to 'recommended' in Serialise.cs
@peterjamesnugent
Spatial_Engine: Fix XML documentation spelling and grammar errors
5bcccf0 
- Fix 'the the' to 'the' in DominantVector.cs
- Fix 'lines lengths' to 'line lengths' in DominantVector.cs
- Fix 'length's' to 'lengths' in DominantVector.cs
- Fix 'proeprties' to 'properties' in MultiLinearLayout.cs
- Fix 'offseet' to 'offset' in OffsetCurveLayout.cs
- Fix 'accomodate' to 'accommodate' in ElementVertices.cs
- Fix 'vertecies' to 'vertices' in ElementVertices.cs
- Fix 'definied' to 'defined' in InternalElements2D.cs
- Fix 'geometricly' to 'geometrically' in ElementCurves.cs
- Fix 'definintion' to 'definition' in ElementCurves.cs
@peterjamesnugent
Structure_Engine: Fix XML documentation spelling and grammar errors
6701d30 
- Fix 'atempts' to 'attempts' in Description.cs
@peterjamesnugent
Versioning_Engine: Fix XML documentation spelling and grammar errors
1625379 
- Fix 'occured' to 'occurred' in VersioningEvents.cs
- Fix 'an new' to 'a new' in DatasetToOldPaths.cs
- Fix 'an new' to 'a new' in DatasetToNewPaths.cs
@peterjamesnugent peterjamesnugent self-assigned this Jun 20, 2025
@peterjamesnugent peterjamesnugent added the type:documentation Wiki, help or in code attributes label Jun 20, 2025
@peterjamesnugent peterjamesnugent added the AI Assisted Code Co-authored with AI label Jun 20, 2025
pawelbaran
pawelbaran previously approved these changes Jun 20, 2025
View reviewed changes
Copy link
Member

@pawelbaran pawelbaran left a comment

Choose a reason for hiding this comment

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

Changes make sense, happy to approve

@pawelbaran
Copy link
Member

@BHoMBot check compliance

@bhombot-ci BHoMBot-CI
Copy link

bhombot-ci bot commented Jun 20, 2025

@pawelbaran to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance

@bhombot-ci BHoMBot-CI
Copy link

bhombot-ci bot commented Jun 20, 2025

Please be advised that the check with reference 44479106831 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 46 additional annotations waiting, made up of 0 errors and 46 warnings.

@bhombot-ci BHoMBot-CI
Copy link

bhombot-ci bot commented Jun 20, 2025

@peterjamesnugent fix requested for adding documentation punctuation.

The documentation attributes missing punctuation have been recorded as annotations on the checks tab.

I will add a full stop (.) to the end of any documentation within the changed files which does not currently end in a suitable piece of punctuation. If you want to perform the fixes in a different manner please resolve this manually and rerun the check.

If you are happy for me to go ahead and perform this action, please reply with:

@BHoMBot fix documentation punctuation ref. 44479106831

@peterjamesnugent
Copy link
Member Author 

@BHoMBot fix documentation punctuation ref. 44479106831

@bhombot-ci BHoMBot-CI
Copy link

bhombot-ci bot commented Jun 20, 2025

@peterjamesnugent sorry, I didn't understand.
Was that comment an instruction for me? If so, could you state again what check you would like me to do?
For a list of available instructions, please see this wiki page.

@peterjamesnugent
Copy link
Member Author

@BHoMBot fix documentation punctuation ref. 44479106831

@bhombot-ci BHoMBot-CI
Copy link

bhombot-ci bot commented Jun 20, 2025

@peterjamesnugent I have queued up your request to fix documentation punctuation. There are 0 requests in the queue ahead of you.

@bhombot-ci BHoMBot-CI
Copy link

bhombot-ci bot commented Jun 20, 2025

@peterjamesnugent I am now going to add full stops (.) to documentation attributes in accordance with the annotations previously made.

@bhombot-ci BHoMBot-CI
Copy link

bhombot-ci bot commented Jun 20, 2025

@peterjamesnugent to confirm I have now resolved the documentation punctuation and pushed a commit to this Pull Request.

@peterjamesnugent
Copy link
Member Author

@BHoMBot check documentation-compliance

@bhombot-ci BHoMBot-CI
Copy link

bhombot-ci bot commented Jun 20, 2025

@peterjamesnugent to confirm, the following actions are now queued:

  • check documentation-compliance

pawelbaran
pawelbaran previously approved these changes Jun 24, 2025
View reviewed changes
Copy link
Member

@pawelbaran pawelbaran left a comment

Choose a reason for hiding this comment

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

Changes make sense, happy to approve

@pawelbaran
Copy link
Member

@BHoMBot check compliance

@bhombot-ci BHoMBot-CI
Copy link

bhombot-ci bot commented Jun 26, 2025

@pawelbaran to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pawelbaran pawelbaran pawelbaran left review comments

@adecler adecler Awaiting requested review from adecler adecler is a code owner

@FraserGreenroyd FraserGreenroyd Awaiting requested review from FraserGreenroyd FraserGreenroyd is a code owner

@IsakNaslundBh IsakNaslundBh Awaiting requested review from IsakNaslundBh IsakNaslundBh is a code owner

@rwemay rwemay Awaiting requested review from rwemay rwemay is a code owner

@al-fisher al-fisher Awaiting requested review from al-fisher al-fisher is a code owner

@tg359 tg359 Awaiting requested review from tg359 tg359 is a code owner

@jamesramsden-bh jamesramsden-bh Awaiting requested review from jamesramsden-bh jamesramsden-bh is a code owner

@michaelhoehn michaelhoehn Awaiting requested review from michaelhoehn

At least 1 approving review is required to merge this pull request.

Assignees

@peterjamesnugent peterjamesnugent

Labels
AI Assisted Code Co-authored with AI type:documentation Wiki, help or in code attributes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

BHoM_Engine: Fix descriptions and puncutation through all engines
3 participants
@peterjamesnugent @pawelbaran @BHoMBot