dr.sybren
/
rignodes
11
14
Fork 2
Code Issues Pull Requests 5 Projects Releases Wiki Activity

Update new nodes description #3

Open
Yann Kervran wants to merge 2 commits from YannK/rignodes:documentation into main
pull from: YannK/rignodes:documentation
merge into: dr.sybren:main

When changing the target branch, be careful to rebase the branch in your fork to match. See documentation.
Conversation 3 Commits 2 Files Changed 1 +42 -14
Yann Kervran commented 2023-06-10 10:58:43 +02:00
First-time contributor
Copy Link

I have added the new nodes in alphabetical order.

I have added the new nodes in alphabetical order.
Yann Kervran added 1 commit 2023-06-10 10:58:45 +02:00
Sybren A. Stüvel requested changes 2023-06-16 12:43:21 +02:00
Sybren A. Stüvel left a comment
Owner
Copy Link

Thanks for the PR!

Could you go over the added descriptions, and make sure that they are consistently written? I lack the grammatical terminology here, but some are written like "XXX: remap a value" and others are of the form "XXX: remaps a value". The latter form would be consistent with the already-existing documentation.

Thanks for the PR! Could you go over the added descriptions, and make sure that they are consistently written? I lack the grammatical terminology here, but some are written like "XXX: remap a value" and others are of the form "XXX: remap**s** a value". The latter form would be consistent with the already-existing documentation.
README.md
@ -86,2 +86,4 @@
## Math Nodes
Add / Subtract / Multiply / Divide
: performs a mathematical operation on its two inputs.
Sybren A. Stüvel commented 2023-06-16 12:41:21 +02:00
Owner
Copy Link

These nodes no longer exist.

These nodes no longer exist.
README.md
@ -93,0 +104,4 @@
: remap a value in a range from a set of two floats to another set of floats.
Math
: add, multiply, substract and divide for floats.
Sybren A. Stüvel commented 2023-06-16 12:41:05 +02:00
Owner
Copy Link

Please use the Oxford comma.

Please use the Oxford comma.
README.md
@ -93,0 +107,4 @@
: add, multiply, substract and divide for floats.
Normal from Points
: calculate normal from a plane define by three points.
Sybren A. Stüvel commented 2023-06-16 12:42:21 +02:00
Owner
Copy Link

'normal from' → 'the normal vector of'

'normal from' → 'the normal vector of'
README.md Outdated
@ -99,0 +125,4 @@
: create a vector from three X/Y/Z float inputs.
Vector Math
: add, multiply, substract, divide or cross product are possibles
Sybren A. Stüvel commented 2023-06-16 12:40:47 +02:00
Owner
Copy Link

Please use the Oxford comma.

Please use the Oxford comma.
Yann Kervran commented 2023-06-16 13:35:07 +02:00
Author
First-time contributor
Copy Link

Thanks for feedback, I wasn’t aware if the Oxford comma, I thought it was a special sign, had to check on Google ;)
Trying to proofread a bit better, I was also wondering if alphabetical order is the best, as the order is non-alphabetical in the node itself for now. Keeping to actual nodes could be easier to follow along.

Thanks for feedback, I wasn’t aware if the Oxford comma, I thought it was a special sign, had to check on Google ;) Trying to proofread a bit better, I was also wondering if alphabetical order is the best, as the order is non-alphabetical in the node itself for now. Keeping to actual nodes could be easier to follow along.
Sybren A. Stüvel commented 2023-06-19 10:36:15 +02:00
Owner
Copy Link

For now, it's mostly just important that the documentation is there. When it comes to order / organisation, you could see if you could use the same grouping as is used in the UI, so that similarly-themed nodes are grouped together.

For now, it's mostly just important that the documentation is there. When it comes to order / organisation, you could see if you could use the same grouping as is used in the UI, so that similarly-themed nodes are grouped together.
Yann Kervran added 1 commit 2023-06-23 20:08:10 +02:00
Yann Kervran commented 2023-06-23 20:10:35 +02:00
Author
First-time contributor
Copy Link

I have proofread a bit, I hope I haven’t missed anything. Thanks for your patience.

I have proofread a bit, I hope I haven’t missed anything. Thanks for your patience.
Yann Kervran requested review from Sybren A. Stüvel 2023-06-23 20:11:06 +02:00
This pull request can be merged automatically.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u documentation:YannK-documentation
git checkout YannK-documentation

Merge

Merge the changes and update on Gitea.
git checkout main
git merge --no-ff YannK-documentation
git checkout main
git merge --ff-only YannK-documentation
git checkout YannK-documentation
git rebase main
git checkout main
git merge --no-ff YannK-documentation
git checkout main
git merge --squash YannK-documentation
git checkout main
git merge YannK-documentation
git push origin main
Sign in to join this conversation.
Reviewers
No reviewers
Sybren A. Stüvel
Labels
Clear labels
No items
No Label
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: dr.sybren/rignodes#3
No description provided.
Delete Branch "YannK/rignodes:documentation"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?