python-packed-resources: minor docs improvements

Author: indygreg

python-packed-resources/src/data.rs

@@ -2,6 +2,8 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
+/*! Declares the foundational data primitives inside packed resources data. */
+
 use {std::borrow::Cow, std::collections::HashMap, std::convert::TryFrom, std::path::Path};
 
 /// Header value for version 1 of resources payload.

python-packed-resources/src/lib.rs

@@ -18,6 +18,10 @@ Later, this data structure is parsed back into composite parts. e.g.
 to a mapping of Python module names and their respective data. This
 data structure is then consulted by a Python interpreter to e.g. power
 the module `import` mechanism.
+
+This crate is developed primarily for
+[PyOxidizer](https://pyoxidizer.readthedocs.io/en/stable/). But it can
+be used outside the PyOxidizer project.
 */
 
 pub mod data;

python-packed-resources/src/parser.rs

@@ -2,9 +2,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-/*!
-Management of Python resources.
-*/
+/*! Parsing of packed resources data blobs. */
 
 use {
     super::data::{

python-packed-resources/src/writer.rs

@@ -2,9 +2,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-/*!
-Embedded Python resources in a binary.
-*/
+/*! Serializing of structures into packed resources blobs. */
 
 use {
     super::data::{BlobInteriorPadding, BlobSectionField, Resource, ResourceField, HEADER_V1},