Skip to content

Fix: removeSignature docstring style in Transaction.h#1228

Merged
rwalworth merged 2 commits intohiero-ledger:mainfrom
ak004:fix-removeSignature-docstring
Mar 17, 2026
Merged

Fix: removeSignature docstring style in Transaction.h#1228
rwalworth merged 2 commits intohiero-ledger:mainfrom
ak004:fix-removeSignature-docstring

Conversation

@ak004
Copy link
Copy Markdown
Contributor

@ak004 ak004 commented Mar 14, 2026

Description:
Update the removeSignature docstring in Transaction.h to match the documentation style used throughout the file.

  • Use imperative voice to align with other method comments
  • Clarify wording to distinguish it from removeAllSignatures
  • Fix @throws formatting and phrasing

Related issue(s):

Fixes #1226

Notes for reviewer:
This change updates documentation only. No functional code or public API behavior was modified.

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

@ak004 ak004 requested review from a team as code owners March 14, 2026 07:58
@ak004 ak004 requested a review from gsstoykov March 14, 2026 07:58
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 14, 2026

Hey @ak004 👋 thanks for the PR!
I'm your friendly PR Helper Bot 🤖 and I'll be riding shotgun on this one, keeping track of your PR's status to help you get it approved and merged.

This comment updates automatically as you push changes -- think of it as your PR's live scoreboard!
Here's the latest:


PR Checks

DCO Sign-off -- All commits have valid sign-offs. Nice work!


GPG Signature -- All commits have verified GPG signatures. Locked and loaded!


Merge Conflicts -- No merge conflicts detected. Smooth sailing!


Issue Link -- Linked to #1226 (assigned to you).


🎉 All checks passed! Your PR is ready for review. Great job!

@github-actions github-actions bot added the status: needs revision A pull request that requires changes before merge label Mar 14, 2026
@ak004 ak004 force-pushed the fix-removeSignature-docstring branch from 5e9c620 to e27b8db Compare March 14, 2026 08:01
@ak004
Copy link
Copy Markdown
Contributor Author

ak004 commented Mar 14, 2026

The commit has now been GPG signed and force-pushed to the branch.
Please let me know if any further changes are needed. Thank you!

Signed-off-by: Mascud Muse Hassan <mascuudmusse44@gmail.com>
@ak004 ak004 force-pushed the fix-removeSignature-docstring branch from e27b8db to d24fd46 Compare March 14, 2026 09:11
@github-actions github-actions bot added status: needs review The pull request is ready for maintainer review and removed status: needs revision A pull request that requires changes before merge labels Mar 14, 2026
Copy link
Copy Markdown
Contributor

@rwalworth rwalworth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution @ak004! The docstring text itself looks great and matches the issue requirements exactly. I found one formatting issue below that needs to be fixed before we can merge - once that's addressed, we'll be good to go. Let me know if you have any questions!

@rwalworth rwalworth added status: needs revision A pull request that requires changes before merge and removed status: needs review The pull request is ready for maintainer review labels Mar 16, 2026
Signed-off-by: Mascud Muse Hassan <mascuudmusse44@gmail.com>
@github-actions github-actions bot added status: needs review The pull request is ready for maintainer review and removed status: needs revision A pull request that requires changes before merge labels Mar 17, 2026
Copy link
Copy Markdown
Contributor

@rwalworth rwalworth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - the indentation is fixed and everything matches the requirements. Running the workflows now and will get this merged!

@rwalworth rwalworth merged commit ea105ef into hiero-ledger:main Mar 17, 2026
11 checks passed
@rwalworth rwalworth removed the status: needs review The pull request is ready for maintainer review label Mar 17, 2026
@ak004 ak004 deleted the fix-removeSignature-docstring branch March 18, 2026 08:23
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.

[Good First Issue]: fix removeSignature docstring to match file conventions

2 participants