Skip to content

Add full stops to rustdocs in client#302

Merged
tcharding merged 1 commit into
rust-bitcoin:masterfrom
jamillambert:0718-client-fullstops
Jul 22, 2025
Merged

Add full stops to rustdocs in client#302
tcharding merged 1 commit into
rust-bitcoin:masterfrom
jamillambert:0718-client-fullstops

Conversation

@jamillambert

Copy link
Copy Markdown
Collaborator

Use AI to go through every file in client and add missing full stops to the rust docs.

There is one typo it also fixed without asking that I noticed.

Part of the fix for issue #296

Comment thread client/src/client_sync/v21/wallet.rs Outdated
Comment on lines +20 to +25
false.into(), // disable_private_keys
false.into(), // blank
serde_json::Value::Null, // passphrase
false.into(), // avoid_reuse
true.into(), // descriptors=true
serde_json::Value::Null, // load_on_startup
false.into(), // disable_private_keys.
false.into(), // blank.
serde_json::Value::Null, // passphrase.
false.into(), // avoid_reuse.
true.into(), // descriptors=true.
serde_json::Value::Null, // load_on_startup.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

These are incorrect. We only want to do rustdocs, in code comments if its not a full sentence then it doesn't get a full stop.

Comment thread client/src/client_sync/v23/wallet.rs Outdated
Comment on lines +34 to +35
/// > 6. descriptors (boolean, optional, default=true) Create a native descriptor wallet. The wallet will use descriptors internally to handle address creation
/// > 6. descriptors (boolean, optional, default=true) Create a native descriptor wallet. The wallet will use descriptors internally to handle address creation.
/// > 6. descriptors (boolean, optional, default=true) Create a native descriptor wallet. The wallet will use descriptors internally to handle address creation.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Duplicate line. But anyways lets not patch the Core docs (same comment as in another place during this review).

@tcharding tcharding left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just two fixes, everything else looks good. What tool did you use? Your editor's AI setup?

tcharding added a commit that referenced this pull request Jul 19, 2025
b4d2681 Add full stops to rustdocs in node (Jamil Lambert, PhD)

Pull request description:

  Use AI to go through every file in node and add missing full stops to the rust docs.

  Together with #302, #303 and #304 Closes #296

ACKs for top commit:
  tcharding:
    ACK b4d2681

Tree-SHA512: 7153ac583469b1481ebcab64e70e2c86a9669fc450059c90e399aca6f55471c8d1cccef9970774b9713d634a9179d0363fe155938d5e9270416a46d7dcd6df36
@jamillambert jamillambert force-pushed the 0718-client-fullstops branch 2 times, most recently from 5472a76 to 59a163f Compare July 21, 2025 09:26
@jamillambert

jamillambert commented Jul 21, 2025

Copy link
Copy Markdown
Collaborator Author

Just two fixes, everything else looks good. What tool did you use? Your editor's AI setup?

Removed the change to section from Core docs. Removed the changes to comments, not sure why it did just this section and not everywhere. Also not sure why it duplicated that one line.

NB. there were other errors it made, just that I found them before committing the changes. Still a lot quicker than trying to do this manually.

I used copilot in vscode in agent mode with GPT-4.1. I pay for copilot through github.

tcharding
tcharding previously approved these changes Jul 22, 2025

@tcharding tcharding left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ACK 59a163f

@tcharding

Copy link
Copy Markdown
Member

Needs rebase mate.

Use AI to go through every file in client and add missing full stops to
the rust docs.
@jamillambert

Copy link
Copy Markdown
Collaborator Author

Rebased

@tcharding tcharding left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ACK 4a2d02e

@tcharding tcharding merged commit 68700ef into rust-bitcoin:master Jul 22, 2025
30 checks passed
blaze-smith470pm added a commit to blaze-smith470pm/corepc that referenced this pull request Sep 26, 2025
4a2d02e75219a36883c5407643ff7d02f284d5d4 Add full stops to rustdocs in Client (Jamil Lambert, PhD)

Pull request description:

  Use AI to go through every file in client and add missing full stops to the rust docs.

  There is one typo it also fixed without asking that I noticed.

  Part of the fix for issue #296

ACKs for top commit:
  tcharding:
    ACK 4a2d02e75219a36883c5407643ff7d02f284d5d4

Tree-SHA512: 5d7b71ad93ef2d86b5b7212fa9f157ca98f4ce02767b044e991a4a8f1e91393ecb054f1cbb323e873f4253e95862c0854a4e0fc32998571af56bccd7ffab0543
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants