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

Reflection_Engine: Extract descriptions of enum options #1586

Merged
merged 2 commits into from
Mar 19, 2020

Conversation

IsakNaslundBh
Copy link
Contributor

Issues addressed by this PR

Closes #1584

Adding the options of the enums, and their inner descriptions, to the description text of an enum. Enum values and text below added:

image

Test files

Changelog

Additional comments

@IsakNaslundBh IsakNaslundBh added the type:documentation Wiki, help or in code attributes label Mar 17, 2020
@IsakNaslundBh IsakNaslundBh added this to the BHoM 3.1 β RC milestone Mar 17, 2020
@IsakNaslundBh IsakNaslundBh requested a review from adecler as a code owner March 17, 2020 13:56
@IsakNaslundBh IsakNaslundBh self-assigned this Mar 17, 2020
Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

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

The code looks fine, but I have a question as to whether we really want to display all values? Some of our enums can be quite large, this might create a massive wall of text on the description? I know that might be an edge case, which is why I'd be happy to approve if you're happy @IsakNaslundBh but figured I'd raise it.

@IsakNaslundBh
Copy link
Contributor Author

@FraserGreenroyd Thought about that, but thought it never would get tooo bad. But could put a limit of say 10 items, and state something like "...and more" after.

Do you have an example of a really long enum, so I can check how it looks?

@FraserGreenroyd
Copy link
Contributor

@IsakNaslundBh I would support an and more option - Environment Space Type is the first one that springs to mind as being a bit on the longer side.

Copy link
Member

@alelom alelom left a comment

Choose a reason for hiding this comment

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

Works fine, code LGTM.

@IsakNaslundBh
Copy link
Contributor Author

/azp run BHoM_Engine.CheckInstaller

@IsakNaslundBh
Copy link
Contributor Author

BHoM_Engine.CheckCompliance

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Wiki, help or in code attributes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reflection_Engine: Get Enum item options and Descriptions
4 participants