-
Notifications
You must be signed in to change notification settings - Fork 5
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
HYDRA-951 : Add Maya command plugin to query build info #163
HYDRA-951 : Add Maya command plugin to query build info #163
Conversation
@@ -48,6 +49,7 @@ target_include_directories(${TARGET_NAME} | |||
PRIVATE | |||
$<$<BOOL:${UFE_FOUND}>:${UFE_INCLUDE_DIR}> | |||
$<$<BOOL:${MayaUsd_FOUND}>:${MAYAUSD_INCLUDE_DIR}> | |||
${CMAKE_BINARY_DIR} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what's this for?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
unintended inclusion. removed it.
static void* creator() { return new MayaHydraPluginInfoCommand(); } | ||
static MSyntax createSyntax(); | ||
|
||
static const MString commandName; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where this member was used?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
did you mean to ask about commandName ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, commandName
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we have a ticket to remove it from the mayaHydra command?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. A file was missed to be added to this PR. Added now.
As per my comments elsewhere, if we have a new command to query mayaHydra information, we should remove it from the mayaHydra command: |
e661515
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are we removing this? Seems like useful information.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To print help of a mel command users are using help . So this was a bit redundant. This was also part of the description in the ticket.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But help theCommand only lists the flags and their argument types. This is information about use. I would challenge that part of the ticket, and if it is really felt like it's a good idea, then move the information to a Markdown page in the repo. This doesn't address the manual maintenance objection, but I still think it's worth it. My preference would be to keep the -help flag.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair point.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am okay with leaving the help if it provides "how to use" information but I would like to avoid to list all the args as those need to be kept in sync with the args help. Maybe add something like:
For more information about supported arguments and their types use help
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shall we move the detailed information to a Markdown file then? Maybe a new markdown file here: https://github.com/Autodesk/maya-hydra/tree/dev/doc
No description provided.