Skip to content

Commit 703caeb

Browse files
committed
Doc fixes
1 parent 23b97ea commit 703caeb

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

src/lib.rs

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,11 @@ fn is_prohibited_bidirectional_text(s: &str) -> bool {
123123
false
124124
}
125125

126-
/// [RFC 3419]: https://tools.ietf.org/html/rfc3419
126+
/// Prepares a string with the Nameprep profile of the stringprep algorithm.
127+
///
128+
/// Nameprep is defined in [RFC 3491][].
129+
///
130+
/// [RFC 3491]: https://tools.ietf.org/html/rfc3491
127131
pub fn nameprep<'a>(s: &'a str) -> Result<Cow<'a, str>, Error> {
128132
// 3. Mapping
129133
let mapped = s.chars()
@@ -167,7 +171,11 @@ pub fn nameprep<'a>(s: &'a str) -> Result<Cow<'a, str>, Error> {
167171
Ok(Cow::Owned(normalized))
168172
}
169173

170-
/// [RFC 3920, Appendix A] https://tools.ietf.org/html/rfc3920#appendix-A
174+
/// Prepares a string with the Nodeprep profile of the stringprep algorithm.
175+
///
176+
/// Nameprep is defined in [RFC 3920, Appendix A][].
177+
///
178+
/// [RFC 3920, Appendix A]: https://tools.ietf.org/html/rfc3920#appendix-A
171179
pub fn nodeprep<'a>(s: &'a str) -> Result<Cow<'a, str>, Error> {
172180
// A.3. Mapping
173181
let mapped = s.chars()
@@ -221,7 +229,11 @@ fn prohibited_node_character(c: char) -> bool {
221229
}
222230
}
223231

224-
/// [RFC 3920, Appendix B] https://tools.ietf.org/html/rfc3920#appendix-B
232+
/// Prepares a string with the Resourceprep profile of the stringprep algorithm.
233+
///
234+
/// Nameprep is defined in [RFC 3920, Appendix B][].
235+
///
236+
/// [RFC 3920, Appendix B]: https://tools.ietf.org/html/rfc3920#appendix-B
225237
pub fn resourceprep<'a>(s: &'a str) -> Result<Cow<'a, str>, Error> {
226238
// B.3. Mapping
227239
let mapped = s.chars()

0 commit comments

Comments
 (0)