BlueQuartzSoftware / simplnx

The backend algorithms and framework associated with DREAM3DNX, a data analysis program for materials science data analytics
http://www.dream3d.io/
Other
7 stars 9 forks source link

DOC: Misspelled words, request to wrap messages in "Filter Parameters" tab, etc. #993

Closed StopkaKris closed 1 month ago

StopkaKris commented 2 months ago

Is there an existing issue for this?

Brief Description of the Documentation Issue or Improvement

Please see the request/suggestions below to fix documentation and messages to DREAM.3D users:

  1. The documentation for the Compute Average C-Axis Orientations filter has “then” misspelled as “thne”.
  2. The filters for which warning messages were added in the Filter Parameters tab should be modified as follows: 2a. Create a link break between "Feature Data Modification Warning" and the actual warning to improve readability. 2b. Can we wrap the text of the actual warning message? Without wrapping it, the Filter Parameters tab requires the user to scroll to the right to see the parameters as shown in the screenshot below. 2c These filters are also the only ones that state "The values below are in the US locale". Is this essential for these filters, or could it be assumed/written somewhere that everything DREAM.3D reports is in the US locale?

image

Version

DREAM3D NX (version 7)

What section of the documentation did you encounter the discrepancy in? [Further details may be required during triage process]

No response

Anything else?

No response

Code of Conduct

imikejackson commented 2 months ago

@StopkaKris Here are all the changes. Thoughts?

Screenshot 2024-07-08 at 15 06 03

StopkaKris commented 2 months ago

@imikejackson that looks great regarding the first two points. What are your thoughts on removing "The values below are in the US locale"?

imikejackson commented 2 months ago

@StopkaKris We wanted to be clear about the formatting of numbers that appear in these messages which is why we have the blanket statement. Right now we don't have a way for the filter to turn that message off. The feedback from our European users was that there was some confusion when numbers were presented in different locales so we try to make it clear how numeric values are formatted.

StopkaKris commented 2 months ago

@imikejackson That makes sense, thank you for clarifying.

imikejackson commented 1 month ago

@StopkaKris I'm going to close this issue as everything is either addressed or has been committed to the repos and will be in the next version of DREAM3D-NX.