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

bjorn/cnx-1112-get-user-facing-names-of-properties #526

Merged

Conversation

bjoernsteinhagen
Copy link
Contributor

Description & motivation

  • Linked to CNX-1112 : property keys should mirror UI names (not api representation).

Changes:

  • Changed frame properties, shell properties, material proxies and section proxies to all use UI names
  • Add units to all attributes where applicable. This was done only for distance related units (mm, mm², mm³) etc. More complicated units related to force, stress, temperature etc. not part of the scope of this ticket. This will be dealt with in CNX-1097

Screenshots:

Frame Section Properties

Screenshot 2025-01-27 233053

Shell Section Properties

Screenshot 2025-01-27 233413

Section Proxies Properties

Screenshot 2025-01-27 233554

Material Proxies Properties

Screenshot 2025-01-27 233717

Checklist:

  • My pull request follows the guidelines in the Contributing guide?
  • My pull request does not duplicate any other open Pull Requests for the same update/change?
  • My commits are related to the pull request and do not amend unrelated code or documentation.
  • My code follows a similar style to existing code.
  • I have added appropriate tests.
  • I have updated or added relevant documentation.

Copy link

linear bot commented Jan 27, 2025

Copy link

codecov bot commented Jan 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 17.35%. Comparing base (4d7225f) to head (7f4e971).
Report is 1 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #526   +/-   ##
=======================================
  Coverage   17.35%   17.35%           
=======================================
  Files         239      239           
  Lines        4805     4805           
  Branches      579      579           
=======================================
  Hits          834      834           
  Misses       3941     3941           
  Partials       30       30           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -98,20 +99,17 @@ private void GetPropertyModifiers(string sectionName, Dictionary<string, object?
Dictionary<string, object?> modifiers =
new()
{
["crossSectionalAreaModifier"] = stiffnessModifiersArray[0],
Copy link
Member

Choose a reason for hiding this comment

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

we don't have property naming standards atm, but the standing rule is using the api prop name in camelcase with no spaces. would prefer to keep this convention for now, but not critical

Copy link
Contributor Author

Choose a reason for hiding this comment

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

cc'ing @bimgeek. I think we'll need to formalize this for all (either camel or user facing).

Copy link
Contributor

Choose a reason for hiding this comment

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

Since we are using user-facing property names in Revit, I understand that this is our target in other connectors for data extraction workflows as it's easier to navigate. However, @clairekuang knows better.

@bjoernsteinhagen bjoernsteinhagen merged commit bb252a5 into dev Jan 29, 2025
5 checks passed
@bjoernsteinhagen bjoernsteinhagen deleted the bjorn/cnx-1112-get-user-facing-names-of-properties branch January 29, 2025 10:25
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.

4 participants