[DYN-7874] As a Dynamo user I do not want the default group description text #15885

ivaylo-matov · 2025-03-04T16:41:41Z

Purpose

This PR addresses DYN-7874. It adds a new preference setting to enable | disable the default description text for groups. Previously, users had to manually delete the default text each time they created a group. Now, they can toggle this behavior in Preferences.

Key Changes:

Added ShowDefaultGroupDescription setting in PreferenceSettings.cs.
Added a ToggleButton in PreferencesView.xaml to control the setting.
Updated AnnotationTextConverter to check the state of ShowDefaultGroupDescription. If ShowDefaultGroupDescription==true && AnnotationDescriptionText == GroupDefaultsText, it passes string.Empty intead of the actual value of AnnotationDescriptionText .

Declarations

Check these if you believe they are true

The codebase 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
All tests pass using the self-service CI.
Snapshot of UI changes, if any.
Changes to the API follow Semantic Versioning and are documented in the API Changes document.
This PR modifies some build requirements and the readme is updated
This PR contains no files larger than 50 MB

Release Notes

This PR adds a new preference setting to enable | disable the default description text for groups. Previously, users had to manually delete the default text each time they created a group. Now, they can toggle this behavior in Preferences.

Reviewers

@QilongTang
@reddyashish

FYIs

@dnenov
@achintyabhat

…he-default-group-description-text

github-actions

See the ticket for this pull request: https://jira.autodesk.com/browse/DYN-7874

ivaylo-matov · 2025-03-04T16:51:19Z

~~aware of the failed build. resolving now~~

reddyashish

Changes look good, need to resolve conflicts.

…ion-text

johnpierson · 2025-03-04T18:26:41Z

First, I like this idea quite a bit as descriptions are often not required.

however, this is causing what I feel is a regression in user experience. If a user went through the effort of removing these descriptions in a previous version, they are now surfacing when a file from a previous version of Dynamo is opened in this dev version with "Use Default Description" enabled. And often times users will remove descriptions from some groups, but not all groups.

This will surely tick off some users.

is there a requirement for this to modify existing groups in a file that has been opened? If so, I would lean toward prompting the user before changing the groups for them.

cc @jnealb

reddyashish · 2025-03-04T19:41:19Z

One test failing: [Dynamo.Tests.Configuration.PreferenceSettingsTests.TestImportCopySettings]

reddyashish · 2025-03-04T19:46:26Z

First, I like this idea quite a bit as descriptions are often not required.

however, this is causing what I feel is a regression in user experience. If a user went through the effort of removing these descriptions in a previous version, they are now surfacing when a file from a previous version of Dynamo is opened in this dev version with "Use Default Description" enabled. And often times users will remove descriptions from some groups, but not all groups.

This will surely tick off some users.

is there a requirement for this to modify existing groups in a file that has been opened? If so, I would lean toward prompting the user before changing the groups for them.

cc @jnealb

In that case, we can make this change only for newly created groups and i think that would be ideal for all. @achintyabhat @hwahlstrom What do you think?

johnpierson · 2025-03-04T20:02:36Z

Also, this feature does not work accross different languages currently.

Created graph in spanish dynamo, opened in english dynamo, toggled the setting.

johnpierson · 2025-03-04T21:03:58Z

src/DynamoCoreWpf/ViewModels/Core/DynamoViewModel.cs

+        /// <param name="showDefault">Whether to apply the default description or clear it.</param>
+        public void ApplyAnnotationDescriptionSetting(bool showDefault)
+        {
+            foreach (var workspace in Model.Workspaces)


If a user has a custom node (dyf) open in the background, this will modify groups within the custom node resulting in a node that has been edited.

@ivaylo-matov In this case, we want to check for groups only in the homeworkspace?

@reddyashish , my understanding was that the problem was in marking the cunstom node as modified and not removing the group description from it in principle. This should be addressed now. I think the idea is to remove (tunr off) the descriptions consistently in every workspace. Hope that makes sense.

So your changes won't remove the group description in the custom node workspace? Confused when you say every workspace as only one homeworkspace will be opened at one time.

apologies if my explanation was unclear

If we have one graph open along with a couple of custom nodes, Model.Workspaces will return three items:

1x HomeWorkspaceModel

2x CustomNodeWorkspaceModels

When a user turns off the default group description in Preferences, Dynamo will:

Apply this change to both the open graph and the two custom nodes.

Ensure that default group descriptions are disabled everywhere, so that everuthing is consistent.

Prevent a situation where the main graph (HomeWorkspaceModel) hides the default group description, while custom nodes (CustomNodeWorkspaceModels) still display it.

The purpose of RefreshAnnotationDescriptions() is not to remove the description value. Instead, it reassigns the same description to each group, triggering RaisePropertyChanged().

This allows AnnotationTextConverter to detect the change and update the group view by setting the description to string.Empty.

hwahlstrom · 2025-03-05T09:35:33Z

First, I like this idea quite a bit as descriptions are often not required.
however, this is causing what I feel is a regression in user experience. If a user went through the effort of removing these descriptions in a previous version, they are now surfacing when a file from a previous version of Dynamo is opened in this dev version with "Use Default Description" enabled. And often times users will remove descriptions from some groups, but not all groups.
This will surely tick off some users.
is there a requirement for this to modify existing groups in a file that has been opened? If so, I would lean toward prompting the user before changing the groups for them.
cc @jnealb

In that case, we can make this change only for newly created groups and i think that would be ideal for all. @achintyabhat @hwahlstrom What do you think?

I agree, make it apply to newly created groups only. Would that resolve the issue, @johnpierson ?

ivaylo-matov · 2025-03-05T11:07:03Z

Thanks for the feedback @johnpierson .
I might have a solution for two of the points:

How do you test wilt different languages? Does not seem to work completely on the builds. If I chage the language only a few of the button will be translated and the new groups will have default text in EN.
For example, CultureInfo.CurrentUICulture.Name will return es-ES ,but Resources.ResourceManager.GetString("GroupDefaultText", CultureInfo.CurrentUICulture) will return the text in EN 🤨

johnpierson · 2025-03-05T14:02:22Z

@hwahlstrom that would work for me! New groups only.

@ivaylo-matov - I couldn't get the sandbox language flag to work either (https://dynamobim.org/multilingual-dynamo/), so I created a DYN in Revit with these instructions https://help.autodesk.com/view/RVT/2024/ENU/?guid=GUID-BD09C1B4-5520-475D-BE7E-773642EEBD6C

Let me know when your new revisions are in and I can test!

Also, not 100% sure the cross-langage thing applies if we only do it on newly created groups. :)

ivaylo-matov · 2025-03-05T18:36:55Z

@johnpierson, all ready for testing. As mentioned above, I changed the strategy, and it now works with existing groups as well. In my opinion, this solution is better and addresses the points you raised, but let me know if you still prefer applying the changes only to new groups.

It also seems to work across different languages. See updated jifs in description.

johnpierson · 2025-03-05T19:53:38Z

Looks great @ivaylo-matov !

Everything works how I would hope. The only odd (kinda) experience is if you copy a group that has had the default text modified with preferences, it will now be modified. But I do not think that is a problem.

reddyashish · 2025-03-18T12:14:48Z

Triggered the job again: https://master-5.jenkins.autodesk.com/job/Dynamo/job/DynamoSelfServe/job/pullRequestValidation/17393/ as the previous one did not finish.

reddyashish · 2025-03-18T12:19:38Z

@ivaylo-matov one comment left here: #15885 (comment)

reddyashish · 2025-03-18T12:49:18Z

Looks like this test Dynamo.Tests.Configuration.PreferenceSettingsTests.TestImportCopySettings is failing here. Can you verify that?

ivaylo-matov · 2025-03-18T14:32:42Z

TestImportCopySettings

~~Fails here as well. Will take a look today~~
@reddyashish , the latest commit should solve the problem with TestImportCopySettings

ivaylo-matov added 3 commits March 3, 2025 11:05

first proposal

64e377b

global update

1c188d6

Merge remote-tracking branch 'upstream/master' into DYN-7874-Toggle-t…

2f82c9c

…he-default-group-description-text

github-actions bot changed the title ~~[DUN-7874] As a Dynamo user I do not want the default group description text~~ DYN-: [DUN-7874] As a Dynamo user I do not want the default group description text Mar 4, 2025

github-actions bot reviewed Mar 4, 2025

View reviewed changes

ivaylo-matov changed the title ~~DYN-: [DUN-7874] As a Dynamo user I do not want the default group description text~~ [DYN-7874] As a Dynamo user I do not want the default group description text Mar 4, 2025

Update PublicAPI.Unshipped.txt

066f925

reddyashish reviewed Mar 4, 2025

View reviewed changes

ivaylo-matov and others added 2 commits March 4, 2025 17:47

Merge branch 'master' into DYN-7874-Toggle-the-default-group-descript…

b4a073f

…ion-text

resources

ccb0869

johnpierson reviewed Mar 4, 2025

View reviewed changes

update

12409d8

Update DynamoSettings-NewSettings.xml

c90d1d9

reddyashish approved these changes Mar 18, 2025

View reviewed changes

reddyashish merged commit 44bcce2 into DynamoDS:master Mar 18, 2025
24 checks passed

zeusongit added this to the 3.5 milestone Mar 19, 2025

[DYN-7874] As a Dynamo user I do not want the default group description text #15885

[DYN-7874] As a Dynamo user I do not want the default group description text #15885

Uh oh!

Conversation

ivaylo-matov commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Declarations

Release Notes

Reviewers

FYIs

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

ivaylo-matov commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

reddyashish left a comment

Choose a reason for hiding this comment

Uh oh!

johnpierson commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

reddyashish commented Mar 4, 2025

Uh oh!

reddyashish commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnpierson commented Mar 4, 2025

Uh oh!

johnpierson Mar 4, 2025

Choose a reason for hiding this comment

Uh oh!

reddyashish Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

ivaylo-matov Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reddyashish Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

ivaylo-matov Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

hwahlstrom commented Mar 5, 2025

Uh oh!

ivaylo-matov commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnpierson commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ivaylo-matov commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnpierson commented Mar 5, 2025

Uh oh!

reddyashish commented Mar 18, 2025

Uh oh!

reddyashish commented Mar 18, 2025

Uh oh!

reddyashish commented Mar 18, 2025

Uh oh!

ivaylo-matov commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ivaylo-matov commented Mar 4, 2025 •

edited

Loading

ivaylo-matov commented Mar 4, 2025 •

edited

Loading

johnpierson commented Mar 4, 2025 •

edited

Loading

reddyashish commented Mar 4, 2025 •

edited

Loading

ivaylo-matov Mar 18, 2025 •

edited

Loading

ivaylo-matov commented Mar 5, 2025 •

edited

Loading

johnpierson commented Mar 5, 2025 •

edited

Loading

ivaylo-matov commented Mar 5, 2025 •

edited

Loading

ivaylo-matov commented Mar 18, 2025 •

edited

Loading