D6630: rust-docstrings: add missing module docstrings

Alphare (Raphaël Gomès) phabricator at mercurial-scm.org
Fri Jul 12 04:50:24 EDT 2019


Alphare updated this revision to Diff 15893.

REPOSITORY
  rHG Mercurial

CHANGES SINCE LAST UPDATE
  https://phab.mercurial-scm.org/D6630?vs=15843&id=15893

CHANGES SINCE LAST ACTION
  https://phab.mercurial-scm.org/D6630/new/

REVISION DETAIL
  https://phab.mercurial-scm.org/D6630

AFFECTED FILES
  rust/hg-core/src/filepatterns.rs
  rust/hg-core/src/utils/files.rs
  rust/hg-core/src/utils/mod.rs

CHANGE DETAILS

diff --git a/rust/hg-core/src/utils/mod.rs b/rust/hg-core/src/utils/mod.rs
--- a/rust/hg-core/src/utils/mod.rs
+++ b/rust/hg-core/src/utils/mod.rs
@@ -1,3 +1,12 @@
+// utils module
+//
+// Copyright 2019 Raphaël Gomès <rgomes at octobus.net>
+//
+// This software may be used and distributed according to the terms of the
+// GNU General Public License version 2 or any later version.
+
+//! Contains useful functions, traits, structs, etc. for use in core.
+
 pub mod files;
 
 pub fn replace_slice<T>(buf: &mut [T], from: &[T], to: &[T])
diff --git a/rust/hg-core/src/utils/files.rs b/rust/hg-core/src/utils/files.rs
--- a/rust/hg-core/src/utils/files.rs
+++ b/rust/hg-core/src/utils/files.rs
@@ -1,3 +1,14 @@
+// files.rs
+//
+// Copyright 2019
+// Raphaël Gomès <rgomes at octobus.net>,
+// Yuya Nishihara <yuya at tcha.org>
+//
+// This software may be used and distributed according to the terms of the
+// GNU General Public License version 2 or any later version.
+
+//! Functions for fiddling with files.
+
 use std::iter::FusedIterator;
 use std::path::Path;
 
diff --git a/rust/hg-core/src/filepatterns.rs b/rust/hg-core/src/filepatterns.rs
--- a/rust/hg-core/src/filepatterns.rs
+++ b/rust/hg-core/src/filepatterns.rs
@@ -1,3 +1,12 @@
+// filepatterns.rs
+//
+// Copyright 2019 Raphaël Gomès <rgomes at octobus.net>
+//
+// This software may be used and distributed according to the terms of the
+// GNU General Public License version 2 or any later version.
+
+//! Handling of Mercurial-specific patterns.
+
 use crate::{LineNumber, PatternError, PatternFileError};
 use regex::bytes::Regex;
 use std::collections::HashMap;



To: Alphare, #hg-reviewers
Cc: durin42, kevincox, mercurial-devel


More information about the Mercurial-devel mailing list