Skip to content

Commit b5e0a93

Browse files
committed
Add disclaimer about internal crate to each lib.rs
1 parent a424fba commit b5e0a93

File tree

6 files changed

+35
-1
lines changed

6 files changed

+35
-1
lines changed

godot-bindings/src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
66
*/
77

8+
//! # Internal crate of [**godot-rust**](https://godot-rust.github.io)
9+
//!
10+
//! Do not depend on this crate directly, instead use the `godot` crate.
11+
//! No SemVer or other guarantees are provided.
12+
813
pub(crate) mod watch;
914

1015
use std::path::Path;

godot-cell/src/lib.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@
55
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
66
*/
77

8+
//! # Internal crate of [**godot-rust**](https://godot-rust.github.io)
9+
//!
10+
//! Do not depend on this crate directly, instead use the `godot` crate.
11+
//! No SemVer or other guarantees are provided.
12+
//!
13+
//! # Contributor docs
14+
//!
815
//! A re-entrant cell implementation which allows for `&mut` references to be reborrowed even while `&mut`
916
//! references still exist.
1017
//!

godot-codegen/src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
66
*/
77

8+
//! # Internal crate of [**godot-rust**](https://godot-rust.github.io)
9+
//!
10+
//! Do not depend on this crate directly, instead use the `godot` crate.
11+
//! No SemVer or other guarantees are provided.
12+
813
// Codegen has no FFI and thus no reason to use unsafe code.
914
#![forbid(unsafe_code)]
1015

godot-core/src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
66
*/
77

8+
//! # Internal crate of [**godot-rust**](https://godot-rust.github.io)
9+
//!
10+
//! Do not depend on this crate directly, instead use the `godot` crate.
11+
//! No SemVer or other guarantees are provided.
12+
813
// Note that a lot of those are public, but the godot crate still has the final say on what it wants to re-export.
914
// Doing fine-grained visibility restrictions on every level is a useless maintenance chore.
1015
pub mod builder;

godot-ffi/src/lib.rs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,14 @@
55
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
66
*/
77

8-
//! Low level bindings to the provided C core API
8+
//! # Internal crate of [**godot-rust**](https://godot-rust.github.io)
9+
//!
10+
//! Do not depend on this crate directly, instead use the `godot` crate.
11+
//! No SemVer or other guarantees are provided.
12+
//!
13+
//! # Contributor docs
14+
//!
15+
//! Low level bindings to the provided C core API.
916
1017
#![cfg_attr(test, allow(unused))]
1118

godot-macros/src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
66
*/
77

8+
//! # Internal crate of [**godot-rust**](https://godot-rust.github.io)
9+
//!
10+
//! Do not depend on this crate directly, instead use the `godot` crate.
11+
//! No SemVer or other guarantees are provided.
12+
813
mod bench;
914
mod class;
1015
mod derive;

0 commit comments

Comments
 (0)