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

Set10| Add Node Documentation for...(Documentation Added: 31 nodes) #3101

Open
wants to merge 31 commits into
base: master
Choose a base branch
from

Conversation

johnpierson
Copy link
Member

Purpose

Declarations

DSRevitNodesUI.ViewDuplicateOptions.dyn
Revit.Elements.Element.GetJoinedElements.dyn
Revit.Elements.Element.UnjoinAllGeometry.dyn
Revit.Elements.Element.UnjoinGeometry.dyn
Revit.Elements.ElementType.CanBeCopied.dyn
Revit.Elements.ElementType.CanBeDeleted.dyn
Revit.Elements.ElementType.Duplicate.dyn
Revit.Elements.ElementType.FamilyName.dyn
Revit.Elements.ElementType.Name.dyn
Revit.Elements.FamilyInstance.Space.dyn
Revit.Elements.Space.Area.dyn
Revit.Elements.Space.CenterBoundary.dyn
Revit.Elements.Space.CoreBoundary.dyn
Revit.Elements.Space.CoreCenterBoundary.dyn
Revit.Elements.Space.FinishBoundary.dyn
Revit.Elements.Space.Height.dyn
Revit.Elements.Space.IsPointInsideSpace.dyn
Revit.Elements.Space.Location.dyn
Revit.Elements.Space.Name.dyn
Revit.Elements.Space.Number.dyn
Revit.Elements.Space.SetName.dyn
Revit.Elements.Space.SetNumber.dyn
Revit.Elements.Space.Volume.dyn
Revit.Elements.Views.View.ExportAsImage.dyn
Revit.Elements.Views.View.SetCropBoxVisible.dyn
Revit.Elements.Wall.ByCurveAndHeight.dyn
Revit.Elements.WallType.ByName.dyn
Revit.Elements.WallType.Function.dyn
Revit.Elements.WallType.GetThermalProperties.dyn
Revit.Elements.WallType.Name.dyn
Revit.Elements.WallType.Width.dyn

Check these if you believe they are true

  • The code base is in a better state after this PR
  • Is documented according to the standards
  • The level of testing this PR includes is appropriate
  • User facing strings, if any, are extracted into *.resx files
  • Snapshot of UI changes, if any.

Reviewers

@achintyabhat

FYIs

@Amoursol

@johnpierson johnpierson changed the title Set010| Add Node Documentation for...(Documentation Added: 31 nodes) Set10| Add Node Documentation for...(Documentation Added: 31 nodes) Oct 8, 2024

Choose a reason for hiding this comment

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

The node in the example is View.DuplicateView. But the description and file name is for View Duplicate Options. Looks like its been mixed up?

- With Detailing
- As Duplicate

In the example below, the detail view "North Wall Window Detail" is duplicated with a prefix of "-Revision 1" with detailing.

Choose a reason for hiding this comment

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

The node in the example is View.DuplicateView. But the description and file name is for View Duplicate Options. Looks like its been mixed up?

Choose a reason for hiding this comment

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

Note to update the image if needed based on the above comment or rename the image.

@@ -0,0 +1,8 @@
## In Depth
`ElementType.Duplicate` attempts to duplicate the given element with the given name. If the name is already taken an error will be presented on the node.

Choose a reason for hiding this comment

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

"type" is missing here-attempts to duplicate the given element "type" with the given name

Choose a reason for hiding this comment

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

Thanks for highlighting a good use case here with the example :)

Choose a reason for hiding this comment

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

Got a warning in my case as I do not have a pictures folder in this location. It might confuse a novice naive user. Rather suggest, keeping a file path as an input and concatenating with the view name to that path to create the final path.

Choose a reason for hiding this comment

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

Note to update description as needed if the dyn file is updated.

Choose a reason for hiding this comment

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

Note to update image as needed if the dyn file is updated.

Copy link

@achintyabhat achintyabhat left a comment

Choose a reason for hiding this comment

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

This set looks good! Just one minor typo and one of the example needs modification. Then we should be good to go.

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.

2 participants