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

XML_Toolkit: Rename depth property from XMLDepth to Depth #561

Merged
merged 2 commits into from
Dec 5, 2022

Conversation

rboulton-BH
Copy link
Contributor

@rboulton-BH rboulton-BH commented Dec 1, 2022

NOTE: Depends on

BHoM/Versioning_Toolkit#208

Issues addressed by this PR

Closes #560

Rename Bluebeam depth property from XMLDepth to Depth

Test files

Testing should be carried out using XML test procedure: https://burohappold.sharepoint.com/:u:/r/sites/BHoM/02_Current/12_Scripts/03_Alpha/BHoM/XML_Toolkit/XML_Toolkit_PullTest.gh?csf=1&web=1&e=BSk0dH

Changelog

Additional comments

@rboulton-BH rboulton-BH added the good first issue Good for newcomers label Dec 1, 2022
@rboulton-BH rboulton-BH added this to the BHoM 6.0 β MVP milestone Dec 1, 2022
@rboulton-BH rboulton-BH self-assigned this Dec 1, 2022
@rboulton-BH rboulton-BH requested a review from tg359 as a code owner December 1, 2022 10:56
Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

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

This was a deliberate decision in #555 because of the issue with having a double Depth to make this clear it is the XML String representation of Depth. @CKBoulter added a method to query the numerical Depth to avoid confusion.

As seen in this commit and this subsequent commit.

Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

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

Following discussion with @rboulton-BH - actions to resolve this PR are as follows:

  • Change the default return type of the Query.Depth method to be 0 instead of -1
  • Add a description to the Depth property of the Markup object to explain to the user that this is an XML String representation and they may need to use the Query.Depth method to convert to a numerical representation
  • Add = Guid.NewGuid(); to the end of the GUID property in XML_oM/Bluebeam/BluebeamObject.cs
  • Leave the rename from XMLDepth to Depth - following discussion with @rboulton-BH and explaining the reasoning, he is happy with why the decision was originally made, but is also happy that from the UX perspective for SAP based users (which the Bluebeam pull is for) having the property called Depth, with a suitable description, will not cause an issue with their workflows.

@rboulton-BH
Copy link
Contributor Author

Changes requested by @FraserGreenroyd have now been made and checked.

Copy link
Contributor

@CKBoulter CKBoulter left a comment

Choose a reason for hiding this comment

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

Just tested the pull and push tests. All passed after following the procedures.

@FraserGreenroyd
Copy link
Contributor

@BHoMBot check compliance

@bhombot-ci
Copy link

bhombot-ci bot commented Dec 3, 2022

@FraserGreenroyd 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

There are 3 requests in the queue ahead of you.

@FraserGreenroyd FraserGreenroyd added the type:bug Error or unexpected behaviour label Dec 3, 2022
@FraserGreenroyd
Copy link
Contributor

@BHoMBot check core
@BHoMBot check null-handling
@BHoMBot check serialisation
@BHoMBot check versioning

@bhombot-ci
Copy link

bhombot-ci bot commented Dec 3, 2022

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

  • check core
  • check null-handling
  • check serialisation
  • check versioning

There are 16 requests in the queue ahead of you.

@FraserGreenroyd
Copy link
Contributor

@BHoMBot check versioning

@bhombot-ci
Copy link

bhombot-ci bot commented Dec 3, 2022

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

  • check versioning

There are 2 requests in the queue ahead of you.

@FraserGreenroyd
Copy link
Contributor

This PR is causing a problem with versioning - @rboulton-BH let's pick up early next week to resolve - should be straight forward but I think it needs a second PR on Versioning_Toolkit to accomplish.

@FraserGreenroyd
Copy link
Contributor

FraserGreenroyd commented Dec 5, 2022

@BHoMBot check versioning

@bhombot-ci
Copy link

bhombot-ci bot commented Dec 5, 2022

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

  • check versioning

@FraserGreenroyd
Copy link
Contributor

@BHoMBot check versioning

@bhombot-ci
Copy link

bhombot-ci bot commented Dec 5, 2022

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

  • check versioning

@FraserGreenroyd
Copy link
Contributor

@BHoMBot check versioning

@bhombot-ci
Copy link

bhombot-ci bot commented Dec 5, 2022

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

  • check versioning

There are 1 requests in the queue ahead of you.

@FraserGreenroyd
Copy link
Contributor

@BHoMBot check installer

@bhombot-ci
Copy link

bhombot-ci bot commented Dec 5, 2022

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

  • check installer

Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

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

My changes have been addressed, @CKBoulter has approved functionality.

@FraserGreenroyd
Copy link
Contributor

@BHoMBot check ready-to-merge

@bhombot-ci
Copy link

bhombot-ci bot commented Dec 5, 2022

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

  • check ready-to-merge

@FraserGreenroyd FraserGreenroyd merged commit e7cd4d9 into main Dec 5, 2022
@FraserGreenroyd FraserGreenroyd deleted the RenameBluebeamDepth branch December 5, 2022 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers type:bug Error or unexpected behaviour
Projects
None yet
Development

Successfully merging this pull request may close these issues.

XML_Toolkit: Rename Bluebeam depth property
3 participants