resources: Improve error messages when no config annotation exists or type is wrong
#1386
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…or type is wrong
adisbladis
force-pushed
the
resource-error-message
branch
from
3b08080
to
a70af27
Compare
cole-h
reviewed
Jul 10, 2020
| if isinstance(config_type, str): | ||
| if config_type == "ResourceOptions": | ||
| raise TypeError( | ||
| f'{self.__class__} is missing a "config" attribute, for example: `config: nixops.resources.ResourceOptions`, see https://nixops.readthedocs.io/en/latest/plugins/authoring.html' |
There was a problem hiding this comment.
Instead of "for example," maybe we should link to an anchor on the readthedocs page that explains the existence/necessity/usage of config: nixops.resources.ResourceOptions. Then this could become:
Suggested change
| f'{self.__class__} is missing a "config" attribute, for example: `config: nixops.resources.ResourceOptions`, see https://nixops.readthedocs.io/en/latest/plugins/authoring.html' | |
| f'{self.__class__} is missing a "config" attribute, see: https://nixops.readthedocs.io/en/latest/plugins/authoring.html#some-anchor-with-info' |
As long as there is a header, it'll be easy to link to -- maybe a short blurb could go in a new bullet under the "Important Notes" section, and then we can link to https://nixops.readthedocs.io/en/latest/plugins/authoring.html#important-notes.
Note to self: I'll tackle this myself, but ixxie expressed interest in helping improve docs, so I'll wait until that's done.
grahamc
reviewed
Jul 10, 2020
Co-authored-by: Graham Christensen <graham@grahamc.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.