Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs for new and init commands in maturin --help #734

Merged
merged 1 commit into from
Dec 7, 2021
Merged

Fix docs for new and init commands in maturin --help #734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Changelog.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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