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

Set09| Add Node Documentation for...(Documentation Added: 22 nodes) #3100

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

Conversation

johnpierson
Copy link
Member

Purpose

Declarations

Document.FilePath
Document.GetLinkInstances
Document.Location
Level.ByElevation
Level.ByElevationAndName
Level.ByLevelAndOffset
Level.ByLevelOffsetAndName
Level.Elevation
Level.Name
Level.ProjectElevation
LinkElement.GetGeometry
LinkElement.GetLocation
LinkInstance.AllElementsOfCategory
LinkInstance.AllElementsOfCategoryInView
LinkInstance.Document
View.CanViewBeDuplicated
View.DuplicateView
View.HideCategoriesTemporary
View.HideElementsTemporary
View.IsolateCategoriesTemporary
View.IsolateElementsTemporary

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

Choose a reason for hiding this comment

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

Handy example :)

Choose a reason for hiding this comment

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

Thanks for including the difference between the Level.Elevation and ProjectElevation node.

## In Depth
`Level.Elevation` returns the elevation for the given level in project units. `Level.Elevation` reports the value from ground level. If the project's elevation differs, this can be returned with `Level.ProjectElevation`.

In the example below, all levels are collected in the current Revit document. The levels' elevation value are returned. Additionally the levels are sorted by height with "List.SortByKey".

Choose a reason for hiding this comment

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

Comma (,) is missing after "Additionally"

## In Depth
`Level.ProjectElevation` returns the elevation for the given level in project units. `Level.ProjectElevation` reports the value from project origin. If the elevation from ground level is required, this value can be obtained with `Level.Elevation`.

In the example below, all levels are collected in the current Revit document. The levels' project elevation value are returned. Additionally the levels are sorted by height with "List.SortByKey".

Choose a reason for hiding this comment

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

Comma (,) is missing after "Additionally"

Choose a reason for hiding this comment

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

I can see why Toposolids is a good use case for this example. But, the execution time is longer as it generates the solids. Suggest using "Walls" or some other category. If the user has a super large graph open already, don't want to further increase the execution times by having heavy examples. Also suggest using Watch 3D nodes to show the geometry in the image.
Screenshot 2024-10-09 094918
Screenshot 2024-10-09 095732

Choose a reason for hiding this comment

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

Note to update the example description once the example is changed as per the comment above.

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 once the example has been updated as per the comment above. Also suggest using Watch 3D nodes to show the geometry in the image.

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