From 01f0818e94c174dcd53778748708e120cc44ecbd Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Fri, 7 Oct 2022 16:34:42 +0600 Subject: [PATCH] Use consistent naming of our crates Former-commit-id: 1ab5bdfc77e7899791dcf6d21e075146255656d9 --- CHANGELOG.md | 4 ++-- CODE_STYLE.md | 1 + README.md | 12 ++++++------ src/dispatching/repls/commands_repl.rs | 4 ++-- src/dispatching/repls/repl.rs | 4 ++-- src/dispatching/update_listeners/polling.rs | 2 +- src/dispatching/update_listeners/webhooks.rs | 2 +- src/features.md | 4 ++-- 8 files changed, 17 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3f83a4fb..4a1ce0bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -60,7 +60,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Add the `Key: Clone` requirement for `impl Dispatcher` [**BC**]. - `dispatching::update_listeners::{polling_default, polling}` now return a named, `Polling<_>` type. -- Update teloxide-core to v0.7.0 with Bot API 6.1 support, see [its changelog][core07c] for more information [**BC**]. +- Update `teloxide-core` to v0.7.0 with Bot API 6.1 support, see [its changelog][core07c] for more information [**BC**]. [core07c]: https://github.com/teloxide/teloxide-core/blob/master/CHANGELOG.md#070---2022-07-19 @@ -90,7 +90,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed -- Update teloxide-core to v0.6.0 with [Bot API 6.0] support [**BC**]. +- Update `teloxide-core` to v0.6.0 with [Bot API 6.0] support [**BC**]. [Bot API 6.0]: https://core.telegram.org/bots/api#april-16-2022 diff --git a/CODE_STYLE.md b/CODE_STYLE.md index 77803ce3..40b65d86 100644 --- a/CODE_STYLE.md +++ b/CODE_STYLE.md @@ -83,6 +83,7 @@ impl Trait for Wrap { ... } /// [`tokio::fs::File`]: tokio::fs::File /// [`Bot::download_file`]: crate::Bot::download_file ``` +4. Write `teloxide`, `teloxide-macros`, and `teloxide-core`, not "teloxide", "Teloxide", "teloxide-macros" or any other variant. ## Use `Self` where possible diff --git a/README.md b/README.md index ab74b6d7..01955c35 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@
-

teloxide

+

`teloxide`

@@ -24,7 +24,7 @@ ## Highlights - - **Declarative design.** teloxide is based upon [`dptree`], a functional [chain of responsibility] pattern that allows you to express pipelines of message processing in a highly declarative and extensible style. + - **Declarative design.** `teloxide` is based upon [`dptree`], a functional [chain of responsibility] pattern that allows you to express pipelines of message processing in a highly declarative and extensible style. [`dptree`]: https://github.com/teloxide/dptree [chain of responsibility]: https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern @@ -56,7 +56,7 @@ $ set TELOXIDE_TOKEN= $ $env:TELOXIDE_TOKEN= ``` - 4. Make sure that your Rust compiler is up to date (teloxide currently requires rustc at least version 1.58): + 4. Make sure that your Rust compiler is up to date (`teloxide` currently requires rustc at least version 1.58): ```bash # If you're using stable $ rustup update stable @@ -304,7 +304,7 @@ A: No, only the bots API. **Q: Can I use webhooks?** -A: You can! Teloxide has a built-in support for webhooks in `dispatching::update_listeners::webhooks` module. See how it's used in [`examples/ngrok_ping_pong_bot`](examples/ngrok_ping_pong.rs) and [`examples/heroku_ping_pong_bot`](examples/heroku_ping_pong.rs). +A: You can! `teloxide` has a built-in support for webhooks in `dispatching::update_listeners::webhooks` module. See how it's used in [`examples/ngrok_ping_pong_bot`](examples/ngrok_ping_pong.rs) and [`examples/heroku_ping_pong_bot`](examples/heroku_ping_pong.rs). **Q: Can I handle both callback queries and messages within a single dialogue?** @@ -328,7 +328,7 @@ Feel free to propose your own bot to our collection! - [`zamazan4ik/npaperbot-telegram`](https://github.com/zamazan4ik/npaperbot-telegram) — Telegram bot for searching via C++ proposals.
-Show bots using teloxide older than v0.6.0 +Show bots using `teloxide` older than v0.6.0 - [`mxseev/logram`](https://github.com/mxseev/logram) — Utility that takes logs from anywhere and sends them to Telegram. - [`alexkonovalov/PedigreeBot`](https://github.com/alexkonovalov/PedigreeBot) — A Telegram bot for building family trees. @@ -340,7 +340,7 @@ Feel free to propose your own bot to our collection!
-See [700+ other public repositories using teloxide >>](https://github.com/teloxide/teloxide/network/dependents) +See [700+ other public repositories using `teloxide` >>](https://github.com/teloxide/teloxide/network/dependents) ## Contributing diff --git a/src/dispatching/repls/commands_repl.rs b/src/dispatching/repls/commands_repl.rs index d4e82954..fe9d9fb7 100644 --- a/src/dispatching/repls/commands_repl.rs +++ b/src/dispatching/repls/commands_repl.rs @@ -37,7 +37,7 @@ use std::{fmt::Debug, marker::PhantomData}; /// /// ## Handler arguments /// -/// Teloxide provides the following types to the `handler`: +/// `teloxide` provides the following types to the `handler`: /// - [`Message`] /// - `R` (type of the `bot`) /// - `Cmd` (type of the parsed command) @@ -105,7 +105,7 @@ where /// /// ## Handler arguments /// -/// Teloxide provides the following types to the `handler`: +/// `teloxide` provides the following types to the `handler`: /// - [`Message`] /// - `R` (type of the `bot`) /// - `Cmd` (type of the parsed command) diff --git a/src/dispatching/repls/repl.rs b/src/dispatching/repls/repl.rs index fd26e6e2..b352d8e3 100644 --- a/src/dispatching/repls/repl.rs +++ b/src/dispatching/repls/repl.rs @@ -27,7 +27,7 @@ use std::fmt::Debug; /// /// ## Handler arguments /// -/// Teloxide provides the following types to the `handler`: +/// `teloxide` provides the following types to the `handler`: /// - [`Message`] /// - `R` (type of the `bot`) /// - [`Me`] @@ -81,7 +81,7 @@ where /// /// ## Handler arguments /// -/// Teloxide provides the following types to the `handler`: +/// `teloxide` provides the following types to the `handler`: /// - [`Message`] /// - `R` (type of the `bot`) /// - [`Me`] diff --git a/src/dispatching/update_listeners/polling.rs b/src/dispatching/update_listeners/polling.rs index 1543b322..5fb863f0 100644 --- a/src/dispatching/update_listeners/polling.rs +++ b/src/dispatching/update_listeners/polling.rs @@ -67,7 +67,7 @@ where /// /// ## Note /// - /// Teloxide normally (when using [`Dispatcher`] or [`repl`]s) sets this + /// `teloxide` normally (when using [`Dispatcher`] or [`repl`]s) sets this /// automatically via [`hint_allowed_updates`], so you rarely need to use /// `allowed_updates` explicitly. /// diff --git a/src/dispatching/update_listeners/webhooks.rs b/src/dispatching/update_listeners/webhooks.rs index ef94fec4..e327016b 100644 --- a/src/dispatching/update_listeners/webhooks.rs +++ b/src/dispatching/update_listeners/webhooks.rs @@ -49,7 +49,7 @@ pub struct Options { /// `a-z`, `0-9`, `_` and `-` are allowed. The header is useful to ensure /// that the request comes from a webhook set by you. /// - /// Default - teloxide will generate a random token. + /// Default - `teloxide` will generate a random token. pub secret_token: Option, } diff --git a/src/features.md b/src/features.md index c7aa4e6a..1545af78 100644 --- a/src/features.md +++ b/src/features.md @@ -12,7 +12,7 @@ | `trace-adaptor` | Enables the [`Trace`](adaptors::Trace) bot adaptor. | | `erased` | Enables the [`ErasedRequester`](adaptors::ErasedRequester) bot adaptor. | | `full` | Enables all the features except `nightly`. | -| `nightly` | Enables nightly-only features (see the [teloxide-core features]). | +| `nightly` | Enables nightly-only features (see the [`teloxide-core` features]). | | `native-tls` | Enables the [`native-tls`] TLS implementation (**enabled by default**). | | `rustls` | Enables the [`rustls`] TLS implementation. | | `redis-storage` | Enables the [Redis] storage support for dialogues. | @@ -29,6 +29,6 @@ [`native-tls`]: https://docs.rs/native-tls [`rustls`]: https://docs.rs/rustls [`teloxide::utils::UpState`]: utils::UpState -[teloxide-core features]: https://docs.rs/teloxide-core/latest/teloxide_core/#cargo-features +[`teloxide-core` features]: https://docs.rs/teloxide-core/latest/teloxide_core/#cargo-features [`DispatcherBuilder::enable_ctrlc_handler`]: dispatching::DispatcherBuilder::enable_ctrlc_handler \ No newline at end of file