Skip to content

--Update Attributes creation messages to be clearer.#923

Merged
jturner65 merged 2 commits intofacebookresearch:masterfrom
jturner65:MM_ClearerCreationMessages
Nov 11, 2020
Merged

--Update Attributes creation messages to be clearer.#923
jturner65 merged 2 commits intofacebookresearch:masterfrom
jturner65:MM_ClearerCreationMessages

Conversation

@jturner65
Copy link
Copy Markdown
Contributor

Motivation and Context

Attributes creation messages were a bit arcane, so this PR hopes to clarify what exactly is going on.

How Has This Been Tested

C++ and python tests pass

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@jturner65 jturner65 requested a review from aclegg3 November 9, 2020 16:24
@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Nov 9, 2020
@jturner65 jturner65 requested a review from Skylion007 November 9, 2020 16:24
") not parseable configuration file, so new default";
} else {
msg = "New default (" + filename + ")";
msg = filename + " file not found so new default";
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

... so using new...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes. This is meant to inform the user that what they passed was not found in the file system (neither as a configuration file, nor as an appropriate asset that can be used to build a default configuration), so they were given a new one built from the specified default attributes' template. This is meant to inform in case they perhaps spelled the name wrong, and wished to have one built from either a json file or an existing non-json asset.

Copy link
Copy Markdown
Contributor

@Skylion007 Skylion007 Nov 9, 2020

Choose a reason for hiding this comment

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

Suggested change
msg = filename + " file not found so new default";
msg = filename + " file not found so using \"new\" default";

Copy link
Copy Markdown
Contributor Author

@jturner65 jturner65 Nov 9, 2020

Choose a reason for hiding this comment

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

Actually that doesn't really work - this message is prepended to "< attributes type > created"
<< (registerTemplate ? " and registered." : ".");

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

So for example, one feasible output is :

8: I1109 16:33:15.267932 14811 AbstractObjectAttributesManagerBase.h:180] new_default_attributes file not found so new default Stage attributes created.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sounds good to me. Ship it @jturner65

@jturner65 jturner65 force-pushed the MM_ClearerCreationMessages branch from 6d503d7 to d3436ba Compare November 10, 2020 20:34
@jturner65 jturner65 force-pushed the MM_ClearerCreationMessages branch from dc16be4 to 1b50e4d Compare November 11, 2020 17:36
@jturner65 jturner65 merged commit 4696893 into facebookresearch:master Nov 11, 2020
@jturner65 jturner65 deleted the MM_ClearerCreationMessages branch November 11, 2020 19:03
Ram81 pushed a commit to Ram81/habitat-web-sim that referenced this pull request Dec 10, 2020
…h#923)

* --Update Attributes creation messages to be clearer.

* --Reviewer suggestions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Do not delete this pull request or issue due to inactivity.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants