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.

Sign up for GitHub

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

Jump to bottom

refactor(iroh-net,iroh)!: rename to remote_info_iter, fixup some docs #2645

Merged
merged 1 commit into from
Aug 19, 2024
Merged

refactor(iroh-net,iroh)!: rename to remote_info_iter, fixup some docs #2645

merged 1 commit into from
Aug 19, 2024

Conversation

flub
Copy link
Contributor

@flub flub commented Aug 19, 2024

Description

This renames remote_infos_iter to remote_info_iter. This returns an
iterator of remote_info items. Using plural for "info" adds a double
plural together with "iter", creating something of a pleonasm.

Breaking Changes

None right now, this is unreleased.

But Endpoint::remote_infos_iter -> Endpoint::remote_info_iter from
previous breaking changes.

Notes & open questions

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.

@flub
ref(iroh-net,iroh): rename to remote_info_iter, fixup some docs
5b5b5d9 
This renames remote_infos_iter to remote_info_iter.  This returns an
iterator of remote_info items.  Using plural for "info" adds a double
plural together with "iter", creating something of a pleonasm.
@github-actions GitHub Actions
Copy link

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/2645/docs/iroh/

Last updated: 2024-08-19T11:11:41Z

@divagant-martian
Copy link
Contributor

I find remote_infos_iter fine since we iterate many of them instead of one internally, giving something like addresses for example, but fine regardless I think

ramfox
ramfox approved these changes Aug 19, 2024
View reviewed changes
Copy link
Contributor

@ramfox ramfox left a comment

Choose a reason for hiding this comment

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

Ah, interesting. This definitely didn't bother me, but this is more semantically correct.

@dignifiedquire dignifiedquire added this pull request to the merge queue Aug 19, 2024
@dignifiedquire dignifiedquire changed the title ref(iroh-net,iroh): rename to remote_info_iter, fixup some docs refactor(iroh-net,iroh): rename to remote_info_iter, fixup some docs Aug 19, 2024
@dignifiedquire dignifiedquire changed the title refactor(iroh-net,iroh): rename to remote_info_iter, fixup some docs refactor(iroh-net,iroh)!: rename to remote_info_iter, fixup some docs Aug 19, 2024
@dignifiedquire dignifiedquire added this to the v0.23.0 milestone Aug 19, 2024
Merged via the queue into main with commit b17bf1d Aug 19, 2024
29 of 30 checks passed
@flub flub deleted the flub/remote-info-iter branch August 19, 2024 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dignifiedquire dignifiedquire dignifiedquire approved these changes

@ramfox ramfox ramfox approved these changes

@divagant-martian divagant-martian Awaiting requested review from divagant-martian

Assignees
No one assigned
Labels
None yet
Projects
iroh
Archived in project
Milestone
v0.23.0
Development

Successfully merging this pull request may close these issues.
4 participants
@flub @divagant-martian @dignifiedquire @ramfox