Skip to content

Document mr.addGradients with structured help block#248

Open
rmoskwa wants to merge 1 commit into
pulseq-admin:masterfrom
rmoskwa:docs/addGradients
Open

Document mr.addGradients with structured help block#248
rmoskwa wants to merge 1 commit into
pulseq-admin:masterfrom
rmoskwa:docs/addGradients

Conversation

@rmoskwa
Copy link
Copy Markdown
Contributor

@rmoskwa rmoskwa commented May 1, 2026

Tricky one to document because of different output shapes. If anything looks off or the structure looks bad, please edit as you wish.

@rmoskwa
Copy link
Copy Markdown
Contributor Author

rmoskwa commented May 1, 2026

I will also echo your comment from PR #238 here, so we have a record. I did NOT implement the change in this PR, so please feel free to edit as you envision the return descriptions looking like!

I find the return value description of mr.addGradients() to be two detailed - it should just reference the corresponding mr.make...() functions, which in their turn may contain these kind of detailed descriptions.

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