Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhanced RDoc for Enumerable #4938

Merged
merged 3 commits into from Oct 5, 2021
Merged

Enhanced RDoc for Enumerable #4938

merged 3 commits into from Oct 5, 2021

Conversation

BurdetteLamar
Copy link
Member

Treats:

  • #slice_after
  • #slice_when
  • #chunk_while

Plus several minor changes to previous enhancements.

@BurdetteLamar BurdetteLamar added the Documentation Improvements to documentation. label Oct 5, 2021
Copy link
Contributor

@jeremyevans jeremyevans 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 working on this. I only have a couple requests for changes.

enum.c Outdated
*
* enum.slice_when { |elt_before, elt_after| bool }.each { |ary| ... }
* Calls the block with each element and its successor;
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the slice_when documentation can end before this line, since the remaining parts basically repeat the same information.

Copy link
Member Author

Choose a reason for hiding this comment

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

Could not agree more. Removed.

Copy link
Contributor

Choose a reason for hiding this comment

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

To be more clear, I would remove lines 4206-4249. They just provide more examples, but the examples do not result in a better understanding of the method's behavior, IMO.

enum.c Outdated Show resolved Hide resolved
Copy link
Contributor

@jeremyevans jeremyevans left a comment

Choose a reason for hiding this comment

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

Looks good! I recommend removing some existing lines in slice_when's documentation, but I'll leave that decision to you.

enum.c Outdated
*
* enum.slice_when { |elt_before, elt_after| bool }.each { |ary| ... }
* Calls the block with each element and its successor;
Copy link
Contributor

Choose a reason for hiding this comment

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

To be more clear, I would remove lines 4206-4249. They just provide more examples, but the examples do not result in a better understanding of the method's behavior, IMO.

@BurdetteLamar
Copy link
Member Author

Looks good! I recommend removing some existing lines in slice_when's documentation, but I'll leave that decision to you.

Done. I quite agree. Just reluctant to delete a lot of the work of others.

@BurdetteLamar BurdetteLamar merged commit abd4739 into ruby:master Oct 5, 2021
@jeremyevans
Copy link
Contributor

@BurdetteLamar Could you review https://bugs.ruby-lang.org/issues/18765 and make the appropriate updates?

@BurdetteLamar
Copy link
Member Author

@BurdetteLamar Could you review https://bugs.ruby-lang.org/issues/18765 and make the appropriate updates?

Glad to, but will require some study. I don't think I got a notification when this was assigned to me; do I need to turn on some notifications? Also, I don't seem to be able to reply on the issue itself.

@jeremyevans
Copy link
Contributor

Not sure about the redmine notifications or access. I would think you should be able to reply if you are logged in. Maybe @hsbt can help?

@BurdetteLamar
Copy link
Member Author

Right, not logged in. @hsbt, never mind, thanks.

@BurdetteLamar
Copy link
Member Author

@jeremyevans, 2FA reset by @hsbt (for which thanks). I have not been able to overcome 2FA obstacles, so will work without accessing Redmine. Should I reopen this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements to documentation.
2 participants