Mercurial > public > mercurial-scm > hg-stable
diff rust/hg-cpython/src/exceptions.rs @ 41184:dcf818267bc1
rust-cpython: rustdoc improvements
By default, `cargo doc` builds the documentation for public
constructs only, so we make public those that can. Since `cindex`
is not safe, we keep it private.
Unfortunately, the macro syntax of rust-cpython doesn't allow us
to document the classes directly, so we resort to do that at
the module level.
Differential Revision: https://phab.mercurial-scm.org/D5546
| author | Georges Racinet <georges.racinet@octobus.net> |
|---|---|
| date | Sat, 22 Dec 2018 11:38:03 +0100 |
| parents | 5532823e8c18 |
| children | ee943a920606 |
line wrap: on
line diff
--- a/rust/hg-cpython/src/exceptions.rs Thu Jan 10 10:23:22 2019 -0500 +++ b/rust/hg-cpython/src/exceptions.rs Sat Dec 22 11:38:03 2018 +0100 @@ -1,3 +1,15 @@ +// ancestors.rs +// +// Copyright 2018 Georges Racinet <gracinet@anybox.fr> +// +// This software may be used and distributed according to the terms of the +// GNU General Public License version 2 or any later version. + +//! Bindings for Rust errors +//! +//! [`GraphError`] exposes `hg::GraphError` as a subclass of `ValueError` +//! +//! [`GraphError`]: struct.GraphError.html use cpython::exc::ValueError; use cpython::{PyErr, Python}; use hg;