Skip to content

[DOC] Doc for method #run#76

Closed
BurdetteLamar wants to merge 1 commit into
ruby:masterfrom
BurdetteLamar:run_doc
Closed

[DOC] Doc for method #run#76
BurdetteLamar wants to merge 1 commit into
ruby:masterfrom
BurdetteLamar:run_doc

Conversation

@BurdetteLamar

Copy link
Copy Markdown
Member

No description provided.

@BurdetteLamar BurdetteLamar added the documentation Improvements or additions to documentation label Sep 17, 2025
@k0kubun

k0kubun commented Sep 17, 2025

Copy link
Copy Markdown
Member

You've been generating an overwhelming amount of notifications for making the same kind of changes, documentation. Can you prepare all documentation changes you want in ERB first, and then batch all those changes in this single PR? As long as different changes are made in different commits, I can "Rebase and merge" it to preserve the commit history.

If this is going to be your last PR to ERB, I can just merge it as is though.

@BurdetteLamar

BurdetteLamar commented Sep 17, 2025

Copy link
Copy Markdown
Member Author

You've been generating an overwhelming amount of notifications for making the same kind of changes, documentation. Can you prepare all documentation changes you want in ERB first, and then batch all those changes in this single PR? As long as different changes are made in different commits, I can "Rebase and merge" it to preserve the commit history.

If this is going to be your last PR to ERB, I can just merge it as is though.

I

You've been generating an overwhelming amount of notifications for making the same kind of changes, documentation. Can you prepare all documentation changes you want in ERB first, and then batch all those changes in this single PR? As long as different changes are made in different commits, I can "Rebase and merge" it to preserve the commit history.

If this is going to be your last PR to ERB, I can just merge it as is though.

No, not my last PR to ERB.

It's been my habit and preference (over at ruby/ruby and elsewhere, with reviewers @peterzhu2118, @jeremyevans, and others) to put up small PRs when possible; that lets us have one thread of discussion. (I'm primarily a documentor, not a developer, and I'm only moderately comfortable with git and github.)

I'd like to continue small PRs here, but if you feel strongly I'll go large.

Btw, I much appreciate your prompt reviews/merges. Very helpful in keeping me on track.

@k0kubun

k0kubun commented Sep 17, 2025

Copy link
Copy Markdown
Member

Different repos have different maintainers who maintain things differently :)

Yes, I feel strongly that I would rather not receive five notifications from you in a single day like yesterday for documenting a single gem. If we decide to make a lot of comments or threads for different parts, we could split them afterward.

Alternatively, please file all PRs at once. I'm also fine if all these notifications come at the same time. You're forcing me a lot of context switches by sending many PRs with intervals.

@BurdetteLamar

Copy link
Copy Markdown
Member Author

Different repos have different maintainers who maintain things differently :)

Yes, I feel strongly that I would rather not receive five notifications from you in a single day like yesterday for documenting a single gem. If we decide to make a lot of comments or threads for different parts, we could split them afterward.

Alternatively, please file all PRs at once. I'm also fine if all these notifications come at the same time. You're forcing me a lot of context switches by sending many PRs with intervals.

Okay, got it!

@BurdetteLamar

Copy link
Copy Markdown
Member Author

@k0kubun, if I rename branch run_doc here to erb_doc, will that foul up this PR? And if I do so, I'd rename my local branch the same?

@k0kubun

k0kubun commented Sep 17, 2025

Copy link
Copy Markdown
Member

I don't think you can rename the branch associated to an already open PR, but if you want to close it and open another one once with a different branch name, I'm fine with it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants