Patchwork D6630: rust-docstrings: add missing module docstrings

login
register
mail settings
Submitter phabricator
Date July 10, 2019, 11:47 a.m.
Message ID <differential-rev-PHID-DREV-lldj7kknc56tz37jtneo-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/40860/
State Superseded
Headers show

Comments

phabricator - July 10, 2019, 11:47 a.m.
Alphare created this revision.
Herald added subscribers: mercurial-devel, kevincox, durin42.
Herald added a reviewer: hg-reviewers.

REPOSITORY
  rHG Mercurial

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




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

Patch

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@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,12 @@ 
+// files.rs
+//
+// Copyright 2019 Raphaël Gomès <rgomes@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.
+
+//! Functions for fiddling with files.
+
 use std::path::Path;
 
 pub fn get_path_from_bytes(bytes: &[u8]) -> &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@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;