Skip to content

Commit

Permalink
Adjust documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
feds01 committed Dec 11, 2024
1 parent 2c80eb1 commit 7d86d1c
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions crates/teamsearch/src/crash.rs
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
//! Hash Compiler crash handler
//! Teamsearch crash handler
use std::{io::Write, panic::PanicHookInfo, process::exit, sync::atomic, thread};

const BUG_REPORT_MSG: &str = "This is an bug, please file a bug report at";
const BUG_REPORT_URI: &str =
"https://github.com/feds01/teamsearch/issues?labels=bug&template=bug_report";

/// The Hash compiler crash handler. This function should be used to register a
/// `panic` handle for the compiler. It will ensure that only one thread can
/// panic at a time, it will print the panic message, a backtrace, and a link to
/// the bug report page.
/// The crash handler. This function should be used to register a `panic` handle
/// for the program. It will ensure that only one thread can panic at a time, it
/// will print the panic message, a backtrace, and a link to the bug report
/// page.
///
/// # Registering the handler
/// ```ignore
Expand All @@ -26,7 +26,7 @@ pub fn crash_handler(info: &PanicHookInfo) {
let stdout = std::io::stdout();
let mut stdout = stdout.lock();

let _ = write!(&mut stdout, "Sorry :^(\nInternal Compiler Error");
let _ = write!(&mut stdout, "Sorry :^(\nInternal Error");

if let Some(s) = info.payload().downcast_ref::<&str>() {
let _ = writeln!(&mut stdout, ": {s}\n");
Expand Down
2 changes: 1 addition & 1 deletion crates/teamsearch/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Entry point of Bracketlint.
//! Entry point of teamsearch.
use std::process::ExitCode;

Expand Down
2 changes: 1 addition & 1 deletion crates/teamsearch_utils/src/highlight.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Hash Compiler error and warning reporting module.
//! Highlighting utilities.
use std::ops::BitOr;

/// Variants of highlighter colour that can be used.
Expand Down
2 changes: 1 addition & 1 deletion crates/teamsearch_utils/src/logging.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Hash compiler logging utilities. This defines a simple logger with a
//! Logging utilities. This defines a simple logger with a
//! style which should be used across the compiler to log and print messages.
use std::{fmt, io::Write};
Expand Down

0 comments on commit 7d86d1c

Please sign in to comment.