edward/git-config
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

cleanup docs

Browse source
This commit is contained in:
Edward Shen 2021-02-27 23:49:23 -05:00
parent 185e1129bc
commit 5720ccd003
Signed by: edward
GPG key ID: 19182661E818369F
2 changed files with 7 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/file.rs
View file

@ -167,8 +167,6 @@ impl<'a> GitConfig<'a> {
/// the conversion is already implemented, but this function is flexible and
/// will accept any type that implements [`TryFrom<&[u8]>`][`TryFrom`].
///
/// # Examples
///
/// Consider [`Self::get_multi_value`] if you want to get all values of a
/// multivar instead.
///
@ -554,8 +552,8 @@ impl<'a> GitConfig<'a> {
/// multivars, then the latter values are not applied. If there are less
/// new values than old ones then the remaining old values are unmodified.
///
/// *Note*: Mutation order is _not_ guaranteed and is non-deterministic. If
/// you need finer control over which values of the multivar are set,
/// **Note**: Mutation order is _not_ guaranteed and is non-deterministic.
/// If you need finer control over which values of the multivar are set,
/// consider using [`get_raw_multi_value_mut`], which will let you iterate
/// and check over the values instead. This is best used as a convenience
/// function for setting multivars whose values should be treated as an

10
src/parser.rs
View file

@ -7,7 +7,7 @@
//! which can be converted into an [`Event`] iterator. The [`Parser`] also has
//! additional methods for accessing leading comments or events by section.
//!
//! [`GitConfig`]: crate::config::GitConfig
//! [`GitConfig`]: crate::file::GitConfig
use nom::branch::alt;
use nom::bytes::complete::{escaped, tag, take_till, take_while};
@ -31,7 +31,7 @@ use std::{convert::TryFrom, fmt::Display};
/// struct when adding values.
///
/// [`Cow`]: std::borrow::Cow
/// [`GitConfig`]: crate::config::GitConfig
/// [`GitConfig`]: crate::file::GitConfig
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
pub enum Event<'a> {
/// A comment with a comment tag and the comment itself. Note that the
@ -71,7 +71,7 @@ pub enum Event<'a> {
impl Display for Event<'_> {
/// Note that this is a best-effort attempt at printing an `Event`. If
/// there are non UTF-8 values in your config, this will _NOT_ render
/// as read. Consider [`Event::as_bytes`] for one-to-one reading.
/// as read.
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::Value(e) | Self::ValueNotDone(e) | Self::ValueDone(e) => {
@ -163,7 +163,7 @@ pub struct ParsedComment<'a> {
impl Display for ParsedComment<'_> {
/// Note that this is a best-effort attempt at printing an comment. If
/// there are non UTF-8 values in your config, this will _NOT_ render
/// as read. Consider [`Event::as_bytes`] for one-to-one reading.
/// as read.
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
self.comment_tag.fmt(f)?;
if let Ok(s) = std::str::from_utf8(&self.comment) {
@ -449,7 +449,7 @@ impl Display for ParserNode {
/// # ]);
/// ```
///
/// [`GitConfig`]: crate::config::GitConfig
/// [`GitConfig`]: crate::file::GitConfig
/// [`.ini` file format]: https://en.wikipedia.org/wiki/INI_file
/// [`git`'s documentation]: https://git-scm.com/docs/git-config#_configuration_file
/// [`FromStr`]: std::str::FromStr