Skip to content

Commit

Permalink
docs(iroh-base): clarify AddrInfoOptions a little (#2813)
Browse files Browse the repository at this point in the history
## Description

A user did get confused about this, so fair enough.

## Breaking Changes

None

## Notes & open questions

Closes #2802 

Please review my comman use.  I feel entirely incompetent in using
commas.

## Change checklist

- [x] Self-review.
- [x] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [x] Tests if relevant.
- [x] All breaking changes documented.
  • Loading branch information
flub authored Oct 18, 2024
1 parent ed903ae commit a36970a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions iroh-base/src/node_addr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -192,11 +192,11 @@ pub enum AddrInfoOptions {
/// This usually means that iroh-dns discovery is used to find address information.
#[default]
Id,
/// Includes both the relay URL and the direct addresses.
/// Includes the Node ID and both the relay URL, and the direct addresses.
RelayAndAddresses,
/// Only includes the relay URL.
/// Includes the Node ID and the relay URL.
Relay,
/// Only includes the direct addresses.
/// Includes the Node ID and the direct addresses.
Addresses,
}

Expand Down

0 comments on commit a36970a

Please sign in to comment.