CARVIEW |
Select Language
HTTP/2 200
date: Sun, 27 Jul 2025 06:08:52 GMT
content-type: text/html; charset=utf-8
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
etag: W/"1c44b12bebfc6e3611fcb8599b141555"
cache-control: max-age=0, private, must-revalidate
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: no-referrer-when-downgrade
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=ZMAM5Hm25KuZTtkoSwohfPq7HU9MbniIIT6r6i0VcFY5Giu%2FC7Mw9Z88ROKL2iomifSDbHUmCJn4cRcQnOnKNZexH%2FvUQs2MODJbn0qluSO5nR4kAIYj2EkT%2F%2F0cDj%2FSi9C7AfEajIsHA6OJkjnQEqT%2F47%2F3ysm01jPZtqgVWi6xMzBiSxgbS4tB7o%2BLwh7K%2F4y5fLx6tID4mjeyzuBhXne%2F0OIsH7v7IIKSpsV99yQBRMsgsBxXmtqfpxtrzxSh0rU75UPB%2FmK7%2FanJBQWHTA%3D%3D--PGn22weDwdQygb41--Zu4z6YhZV6vFTc19WHdYVA%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.725414764.1753596532; Path=/; Domain=github.com; Expires=Mon, 27 Jul 2026 06:08:52 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Mon, 27 Jul 2026 06:08:52 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: 958E:3C6DB4:1E2F68:2B6C0A:6885C274
Content Pattern: Node Descriptions · DynamoDS/Dynamo Wiki · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 658
Content Pattern: Node Descriptions
hwahlstrom edited this page Jul 10, 2023
·
3 revisions
Node descriptions briefly describe a node’s function and output. In Dynamo, they appear in two places:
- In the node tooltip
- In the documentation browser
Follow these guidelines to ensure consistency and help save time when writing or updating node descriptions.
Descriptions should be one to two sentences. If more info is needed, include it under In Depth in the Documentation Browser.
Sentence case (capitalize the first word of a sentence and any proper nouns). No period at the end.
Language should be as clear and simple as possible. Define acronyms at first mention unless they are known even to non-expert users.
Always prioritize clarity, even if that means deviating from these guidelines.
Do's | Don'ts |
---|---|
Start the description with a third-person verb.
|
Don't start with a second-person verb or with any noun.
|
Use "Returns," "Creates," or another descriptive verb instead of "Gets."
|
Don't use "Get" or "Gets." It's less specific and has several possible translations.
|
When referring to inputs, use "given" or "input" instead of "specified" or any other terms. Omit "given" or "input" when possible to simplify the description and reduce word count.
|
When referring to inputs, to ensure consistency, don't use "specified" or any other term except "given" or "input." Don't mix "given" and "input" in the same description unless needed for clarity.
|
Use "a" or "an" when first referring to an input. Use "the given" or "the input" instead of "a" or "an" as needed for clarity.
|
Don't use "this" when first referring to an input.
|
When first referring to an output or other noun that's the target of the node operation, use "a" or "an." Only use "the" when pairing it with "input" or "given."
|
When first referring to an output or other noun that's the target of the node operation, don't use "the" on its own.
|
Capitalize the first word of a sentence and any proper nouns such as names and traditionally capitalized nouns.
|
Don't capitalize common geometry objects and concepts unless needed for clarity.
|
Capitalize Boolean. Capitalize True and False when referring to the output of Booleans.
|
Don't lowercase Boolean. Don't lowercase True and False when referring to the output of Booleans.
|
Looking for help with using the Dynamo application? Try dynamobim.org.
- Dynamo 2.0 Language Changes Explained
- How Replication and Replication Guide work: Part 1
- How Replication and Replication Guide work: Part 2
- How Replication and Replication Guide work: Part 3
Clone this wiki locally
You can’t perform that action at this time.