Skip to content

Commit

Permalink
Fix docs for new and init commands in maturin --help
Browse files Browse the repository at this point in the history
  • Loading branch information
messense committed Dec 7, 2021
1 parent bc8ad7a commit d18f399
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
2 changes: 2 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

* Fix docs for `new` and `init` commands in `maturin --help` in [#734](https://github.com/PyO3/maturin/pull/734)

## [0.12.4] - 2021-12-06

* Add a `maturin init` command as a companion to `maturin new` in [#719](https://github.com/PyO3/maturin/pull/719)
Expand Down
5 changes: 2 additions & 3 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@
use anyhow::{bail, Context, Result};
use cargo_metadata::MetadataCommand;
use fs_err as fs;
use maturin::GenerateProjectOptions;
use maturin::{
develop, init_project, new_project, source_distribution, write_dist_info, BridgeModel,
BuildOptions, CargoToml, Metadata21, PathWriter, PlatformTag, PyProjectToml, PythonInterpreter,
Target,
BuildOptions, CargoToml, GenerateProjectOptions, Metadata21, PathWriter, PlatformTag,
PyProjectToml, PythonInterpreter, Target,
};
#[cfg(feature = "upload")]
use maturin::{upload_ui, PublishOpt};
Expand Down
4 changes: 3 additions & 1 deletion src/new_project.rs
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,10 @@ impl<'a> ProjectGenerator<'a> {
}
}

// workaround for https://github.com/TeXitoi/structopt/issues/333#issuecomment-712265332
#[cfg_attr(not(doc), allow(missing_docs))]
#[cfg_attr(doc, doc = "Options common to `maturin new` and `maturin init`.")]
#[derive(Debug, StructOpt)]
/// Options common to `maturin new` and `maturin init`.
pub struct GenerateProjectOptions {
/// Set the resulting package name, defaults to the directory name
#[structopt(long)]
Expand Down

0 comments on commit d18f399

Please sign in to comment.