Skip to content

Conversation

dmitry-ganyushin
Copy link
Collaborator

@dmitry-ganyushin dmitry-ganyushin commented Nov 12, 2024

Description of work

7925: EnumeratedStringProperty, type should be the literal "string", not a mangled name
By implementation of Enumerated String Property, the C++ mangled name was placed inside the documentation, and this is fixed as the type of the enumerated string is set to "string". The changed unit test is reverted.

Summary of work

Fixes mangled C++ names in docs for EnumeratedStringProperties. They are mapped to "string" now in the function getUnmangledTypeName in Framework/Kernel/src/Property.cpp

Further detail of work

To test:

ctest -R SimpleAPITest
Check for C++ mangled names in html docs.

No release note needed because it fixes an issue introduced during the development cycle


Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@dmitry-ganyushin dmitry-ganyushin changed the title Fix for Enumerated Strings Properties docs bug Fix for Enumerated String Properties docs bug Nov 12, 2024
@dmitry-ganyushin dmitry-ganyushin self-assigned this Nov 12, 2024
@dmitry-ganyushin dmitry-ganyushin added the Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) label Nov 12, 2024
@dmitry-ganyushin dmitry-ganyushin added this to the Release 6.12 milestone Nov 12, 2024
Copy link
Member

@peterfpeterson peterfpeterson left a comment

Choose a reason for hiding this comment

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

The properties table for Rebin is correct again
image

@peterfpeterson peterfpeterson added the Documentation Issues and pull requests related to documentation label Nov 12, 2024
@SilkeSchomann SilkeSchomann self-assigned this Nov 13, 2024
@SilkeSchomann SilkeSchomann merged commit 8d783cc into main Nov 13, 2024
11 checks passed
@dmitry-ganyushin dmitry-ganyushin deleted the enum-strings-bug branch November 13, 2024 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) Documentation Issues and pull requests related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants