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

OnLogWarningMessage #19

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

EdwardChaplinArchilizer
Copy link

@EdwardChaplinArchilizer EdwardChaplinArchilizer commented Nov 25, 2024

###Purpose
Add guide for generating custom warning messages in Dynamo nodes

This update introduces a comprehensive guide to implementing OnLogWarningMessage in Zero Touch nodes. The guide covers the importance of logging warnings, common use cases, and practical examples to help developers enhance their custom nodes.

Key additions:

  • Step-by-step instructions for integrating OnLogWarningMessage.
  • Example for validating numeric inputs in a grid creation node.
  • Example for handling null or empty collections in a polygon creation node.
  • Example for verifying file type compatibility in a file processing node.

This also adds a new page into the primer under Developing for Dynamo. This new page is called "Advanced Dynamo Node Customisation" and will sit here in the table of contents:
image

###Declarations
Check these if you believe they are true

  • The codebase is in a better state after this PR
  • Is documented according to the standards
  • The level of testing this PR includes is appropriate
  • User facing strings, if any, are extracted into *.resx files
  • All tests pass using the self-service CI.
  • Snapshot of UI changes, if any.
  • Changes to the API follow Semantic Versioning and are documented in the API Changes document.
  • This PR modifies some build requirements and the readme is updated
  • This PR contains no files larger than 50 MB

###Release Notes
Add guide for generating custom warning messages in Dynamo nodes

Reviewers
@dnenov
@achintyabhat
@QilongTang

Informed
@Amoursol

…sage to add a warning message to custom nodes.

Added a new page "Advanced Dynamo Node Customisation" to be the new home for "OnLogWarningMessage", "OnLogInfoMessage", "Custom Node Icons" and any future documentation for node customisation.
@EdwardChaplinArchilizer EdwardChaplinArchilizer changed the title On log warning message OnLogWarningMessage Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant