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

HYDRA-951 : Add Maya command plugin to query build info #163

Merged
merged 8 commits into from
Aug 30, 2024

Conversation

roopavr-adsk
Copy link
Contributor

No description provided.

@roopavr-adsk roopavr-adsk self-assigned this Aug 28, 2024
@@ -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}
Copy link
Collaborator

Choose a reason for hiding this comment

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

what's this for?

Copy link
Contributor Author

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;
Copy link
Collaborator

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?

Copy link
Contributor Author

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 ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

yes, commandName

Copy link
Collaborator

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?

Copy link
Contributor Author

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.

@ppt-adsk
Copy link
Collaborator

As per my comments elsewhere, if we have a new command to query mayaHydra information, we should remove it from the mayaHydra command:
https://github.com/Autodesk/maya-hydra/blob/dev/lib/mayaHydra/mayaPlugin/viewCommand.cpp
And we should change the test
https://github.com/Autodesk/maya-hydra/blob/dev/test/lib/mayaUsd/render/mayaToHydra/testMtohCommand.py
to use your new command, as well as test the new cutId flag. Thanks!

@roopavr-adsk roopavr-adsk changed the title HYDRA-951 : Add Maya command plugin to querry build info HYDRA-951 : Add Maya command plugin to query build info Aug 29, 2024
lilike-adsk
lilike-adsk previously approved these changes Aug 29, 2024
ppt-adsk
ppt-adsk previously approved these changes Aug 29, 2024
Copy link
Collaborator

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.

Copy link
Contributor Author

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.

Copy link
Collaborator

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fair point.

Copy link
Collaborator

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

Copy link
Contributor Author

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

@roopavr-adsk roopavr-adsk merged commit f496ea9 into dev Aug 30, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants