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.

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

Add warning for missing documentation #727

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ executors:
working_directory: ~/projects/Plume
environment:
RUST_TEST_THREADS: 1
FEATURES: <<#parameters.postgres>>postgres<</ parameters.postgres>><<^parameters.postgres>>sqlite<</parameters.postgres>>
FEATURES: <<#parameters.postgres>>postgres<</ parameters.postgres>><<^parameters.postgres>>sqlite<</parameters.postgres>>,ci
DATABASE_URL: <<#parameters.postgres>>postgres://postgres@localhost/plume<</parameters.postgres>><<^parameters.postgres>>plume.sqlite<</parameters.postgres>>


Expand Down
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ postgres = ["plume-models/postgres", "diesel/postgres"]
sqlite = ["plume-models/sqlite", "diesel/sqlite"]
debug-mailer = []
test = []
ci = ["plume-models/ci", "plume-api/ci", "plume-common/ci"]

[workspace]
members = ["plume-api", "plume-cli", "plume-models", "plume-common", "plume-front", "plume-macro"]
3 changes: 3 additions & 0 deletions plume-api/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ edition = "2018"
[dependencies]
serde = "1.0"
serde_derive = "1.0"

[features]
ci = []
2 changes: 2 additions & 0 deletions plume-api/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#![cfg_attr(not(feature = "ci"), warn(missing_docs))]

#[macro_use]
extern crate serde_derive;

Expand Down
1 change: 1 addition & 0 deletions plume-cli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,4 @@ path = "../plume-models"
[features]
postgres = ["plume-models/postgres", "diesel/postgres"]
sqlite = ["plume-models/sqlite", "diesel/sqlite"]
ci = ["plume-models/ci"]
3 changes: 2 additions & 1 deletion plume-cli/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
use dotenv;
#![cfg_attr(not(feature = "ci"), warn(missing_docs))]

use clap::App;
use diesel::Connection;
use dotenv;
use plume_models::{instance::Instance, Connection as Conn, CONFIG};
use std::io::{self, prelude::*};

Expand Down
3 changes: 3 additions & 0 deletions plume-common/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,6 @@ version = "0.4"
[dependencies.pulldown-cmark]
default-features = false
version = "0.2.0"

[features]
ci = []
1 change: 1 addition & 0 deletions plume-common/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#![cfg_attr(not(feature = "ci"), warn(missing_docs))]
#![feature(associated_type_defaults)]

#[macro_use]
Expand Down
3 changes: 3 additions & 0 deletions plume-front/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,6 @@ gettext-utils = { git = "https://github.com/Plume-org/gettext-macros/", rev = "a
lazy_static = "1.3"
serde = "1.0"
serde_json = "1.0"

[features]
ci = []
1 change: 1 addition & 0 deletions plume-front/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#![recursion_limit = "128"]
#![feature(decl_macro, proc_macro_hygiene, try_trait)]
#![cfg_attr(not(feature = "ci"), warn(missing_docs))]

#[macro_use]
extern crate gettext_macros;
Expand Down
1 change: 1 addition & 0 deletions plume-macro/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ syn = "0.15.27"
default = []
postgres = []
sqlite = []
ci = []
1 change: 1 addition & 0 deletions plume-macro/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#![recursion_limit = "128"]
#![cfg_attr(not(feature = "ci"), warn(missing_docs))]

#[macro_use]
extern crate quote;
Expand Down
1 change: 1 addition & 0 deletions plume-models/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,4 @@ diesel_migrations = "1.3.0"
[features]
postgres = ["diesel/postgres", "plume-macro/postgres" ]
sqlite = ["diesel/sqlite", "plume-macro/sqlite" ]
ci = ["plume-macro/ci"]
1 change: 1 addition & 0 deletions plume-models/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#![feature(try_trait)]
#![feature(never_type)]
#![feature(proc_macro_hygiene)]
#![cfg_attr(not(feature = "ci"), warn(missing_docs))]

#[macro_use]
extern crate diesel;
Expand Down
1 change: 1 addition & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#![allow(clippy::too_many_arguments)]
#![cfg_attr(not(feature = "ci"), warn(missing_docs))]
#![feature(decl_macro, proc_macro_hygiene, try_trait)]

#[macro_use]
Expand Down