Skip to content

Fix typos in documentation and comments #13

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

Open
Avicennasis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix typos in documentation and comments #13

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
8 changes: 4 additions & 4 deletions src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ pub enum BinaryError {
NoFuseVersion,
/// The length of the fuse was not found in the binary.
NoFuseLength,
/// The requested fuse to be modifed wasn't present in the fuse wire.
/// The requested fuse to be modified wasn't present in the fuse wire.
FuseDoesNotExist(crate::Fuse),
/// An unknown fuse status was encountered.
///
Expand All @@ -26,12 +26,12 @@ pub enum BinaryError {
value: u8,
},
#[allow(deprecated)]
/// The Node.JS command line flag attempted to be disabled wasn't present.
/// The Node.js command line flag attempted to be disabled wasn't present.
NodeJsFlagNotPresent(crate::patcher::NodeJsCommandLineFlag),
/// The Electron command line flag attempted to be disabled wasn't present.
ElectronOptionNotPresent(crate::patcher::ElectronOption),
#[allow(deprecated)]
/// The Node.JS debugging message attempted to be disabled wasn't present.
/// The Node.js debugging message attempted to be disabled wasn't present.
MessageNotPresent(crate::patcher::DevToolsMessage),
}

Expand Down Expand Up @@ -68,7 +68,7 @@ impl std::error::Error for BinaryError {}
pub enum PatcherError {
/// A part of the provided binary's contents was invalid.
Binary(BinaryError),
/// A different fuse schema version was found then what the library supports.
/// A different fuse schema version was found than what the library supports.
FuseVersion {
/// The supported version of the Electron fuse schema by this library.
expected: u8,
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
//!
//! ### A Note on Effectiveness
//!
//! Any patching this tool does is considered a strong "best effort" as the Chromium, Electron, and Node.JS teams are free to potentially
//! Any patching this tool does is considered a strong "best effort" as the Chromium, Electron, and Node.js teams are free to potentially
//! make changes to the argument parser, set of flags, etc.
//!
//! For a stronger assurance, consider disabling the [dev tools messages](patcher::DevToolsMessage).
Expand Down
12 changes: 6 additions & 6 deletions src/patcher.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ mod private {

/// List of known command line debugging flags that can be disabled
///
/// See the [Node.JS documentation] for details on what each flag does.
/// See the [Node.js documentation] for details on what each flag does.
///
/// [Node.JS documentation]: https://nodejs.org/en/docs/guides/debugging-getting-started/#command-line-options
/// [Node.js documentation]: https://nodejs.org/en/docs/guides/debugging-getting-started/#command-line-options
#[deprecated(
since = "0.2.2",
note = "This has been superseded by the NodeCliInspect fuse."
Expand Down Expand Up @@ -151,12 +151,12 @@ impl Patchable for ElectronOption {
}

/// List of known developer tool command line messages that can be
/// written to stdout by Node.JS during debugging.
/// written to stdout by Node.js during debugging.
///
/// ### Warning
///
/// Disabling these is a worst-case fallback protection against internal changes to the way
/// that Chromium/Electron/Node.JS handle parsing command line arguments. If something is changed
/// that Chromium/Electron/Node.js handle parsing command line arguments. If something is changed
/// and a debugging flag slips through, modifying one of these will cause the application to trigger a segemntation fault
/// and be terminated by the OS, exiting immediately.
#[deprecated(
Expand All @@ -166,11 +166,11 @@ impl Patchable for ElectronOption {
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum DevToolsMessage {
/// The message printed to standard out when Node.JS listens on TCP port.
/// The message printed to standard out when Node.js listens on TCP port.
///
/// Ex: `Debugger listening on 127.0.0.1:9229/uuid`
Listening,
/// The message printed to standard out when Node.JS listens on a websocket.
/// The message printed to standard out when Node.js listens on a websocket.
///
/// Ex: `Debugger listening on ws://127.0.0.1:9229/uuid`
ListeningWs,
Expand Down