Skip to content

Commit a2712cb

Browse files
caugnerbsmth
andauthored
chore: fix some typos (#111)
Co-authored-by: Claas Augner <[email protected]> Co-authored-by: Brian Smith <[email protected]>
1 parent 197dde3 commit a2712cb

30 files changed

+51
-51
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1+
# Welcome to `rari`
2+
13
> [!Warning]
24
> This project is work in progress and lacking most of its documentation.
35
> Anything might change and code will move a lot. We do not encourage using it yet.
46
> We'll have an official announcement before we migrate, so stay tuned.
57
6-
7-
# Welcome to `rari`
8-
98
`rari` is the build system for [MDN](https://developer.mozilla.org).
109

1110
`rari` is hosted by [MDN](https://github.com/mdn).
@@ -17,11 +16,12 @@ To get up and running, follow these steps:
1716
Make sure you have [Rust](https://www.rust-lang.org/) installed, otherwise go to [https://rustup.rs/](https://rustup.rs/).
1817

1918
Clone this repository and run:
19+
2020
```plain
2121
cargo run -- --help
2222
```
2323

24-
### Configuation
24+
### Configuration
2525

2626
Create a `.config.toml` in the current working directory.
2727
Add the following:
@@ -41,6 +41,7 @@ Our project welcomes contributions from any member of our community.
4141
To get started contributing, please see our [Contributor Guide](CONTRIBUTING.md).
4242
4343
-->
44+
4445
By participating in and contributing to our projects and discussions, you acknowledge that you have read and agree to our [Code of Conduct](CODE_OF_CONDUCT.md).
4546

4647
## Resources
@@ -55,7 +56,6 @@ To be updated...
5556

5657
If you have any questions, please reach out to us on [Discord](https://developer.mozilla.org/discord)
5758

58-
5959
## License
6060

6161
This project is licensed under the [Mozilla Public License 2.0](LICENSE.md).

crates/css-definition-syntax/src/walk.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ pub fn walk<T>(
3434
Node::Multiplier(multiplier) => {
3535
walk(&multiplier.term, options, context)?;
3636
}
37-
Node::BooleanExpr(booleann_exp) => {
38-
walk(&booleann_exp.term, options, context)?;
37+
Node::BooleanExpr(boolean_exp) => {
38+
walk(&boolean_exp.term, options, context)?;
3939
}
4040
Node::Token(_)
4141
| Node::Property(_)

crates/rari-cli/main.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ enum Commands {
7070
Serve(ServeArgs),
7171
/// Collect the git history.
7272
GitHistory,
73-
/// Self-update rari (caution if istalled from npm)
73+
/// Self-update rari (caution if installed from npm)
7474
Update(UpdateArgs),
7575
/// Export json schema.
7676
ExportSchema(ExportSchemaArgs),
@@ -388,9 +388,9 @@ fn main() -> Result<(), Error> {
388388
}
389389
if args.all || args.curriculum {
390390
let start = std::time::Instant::now();
391-
let curriclum_pages = build_curriculum_pages()?;
392-
let num = curriclum_pages.len();
393-
urls.extend(curriclum_pages);
391+
let curriculum_pages = build_curriculum_pages()?;
392+
let num = curriculum_pages.len();
393+
urls.extend(curriculum_pages);
394394
info!(
395395
"Took: {: >10.3?} to build curriculum pages ({num})",
396396
start.elapsed()
@@ -537,7 +537,7 @@ fn update(version: Option<String>) -> Result<(), Error> {
537537
let latest = update.get_latest_release().ok();
538538

539539
let target_version = match (&latest, &target_release) {
540-
(None, None) => return Err(anyhow!("No latest release, specigy a version!")),
540+
(None, None) => return Err(anyhow!("No latest release, specify a version!")),
541541
(None, Some(target)) => {
542542
info!("Updating rari to {}", target.version);
543543
&target.version

crates/rari-doc/src/build.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//! # Build Module
22
//!
33
//! The `build` module provides functionality for building pages. The module leverages parallel
4-
//! processing for documentzation pages to improve the efficiency of building large sets files.
4+
//! processing for documentation pages to improve the efficiency of building large sets files.
55
66
use std::borrow::Cow;
77
use std::collections::HashMap;

crates/rari-doc/src/cached_readers.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ pub fn read_sidebar(name: &str, locale: Locale, slug: &str) -> Result<Arc<MetaSi
168168
///
169169
/// If the page is found in the cache, it returns `Ok(page)`.
170170
/// If the page is not found, it returns a `DocError::NotFoundInStaticCache` error.
171-
/// If there is aproblem with the cache, it returns a `DocError::FileCacheBroken` error.
171+
/// If there is a problem with the cache, it returns a `DocError::FileCacheBroken` error.
172172
///
173173
/// # Arguments
174174
///
@@ -618,7 +618,7 @@ pub fn generic_content_files() -> Cow<'static, UrlToPageMap> {
618618
}
619619
}
620620

621-
/// Retrieves the contributor spotlight pages, using the cacche if it is enabled.
621+
/// Retrieves the contributor spotlight pages, using the cache if it is enabled.
622622
///
623623
/// This function returns a `Cow<'static, UrlToPageMap>` containing the contributor spotlight pages.
624624
/// If caching is enabled (as determined by `cache_content()`), it attempts to get the cached

crates/rari-doc/src/error.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ pub enum DocError {
2626
NoParent(PathBuf),
2727
#[error(transparent)]
2828
NoSuchPrefix(#[from] StripPrefixError),
29-
#[error("No curricm root set")]
29+
#[error("No curriculum root set")]
3030
NoCurriculumRoot,
3131
#[error("No generic content root set")]
3232
NoGenericContentRoot,

crates/rari-doc/src/helpers/css_info.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ pub fn css_info_properties(
8585
));
8686
}
8787

88-
out.push(("initial", Cow::Owned(css_inital(locale)?)));
88+
out.push(("initial", Cow::Owned(css_initial(locale)?)));
8989

9090
if at_rule.is_none() {
9191
out.push((
@@ -326,7 +326,7 @@ pub fn css_inherited(locale: Locale) -> Result<String, DocError> {
326326
)
327327
}
328328

329-
pub fn css_inital(locale: Locale) -> Result<String, DocError> {
329+
pub fn css_initial(locale: Locale) -> Result<String, DocError> {
330330
let copy = l10n_json_data("Template", "xref_cssinitial", locale)?;
331331
RariApi::link(
332332
"/Web/CSS/initial_value",

crates/rari-doc/src/helpers/summary_hack.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use crate::error::DocError;
55
use crate::pages::page::{Page, PageLike};
66
use crate::templ::render::render_for_summary;
77

8-
/// There's a few places were we still tansplant content.
8+
/// There's a few places were we still transplant content.
99
/// Yari had a hidden hacky way to do this and we have to mimic this for now.
1010
pub fn get_hacky_summary_md(page: &Page) -> Result<String, DocError> {
1111
let summary_md = page
@@ -22,7 +22,7 @@ pub fn get_hacky_summary_md(page: &Page) -> Result<String, DocError> {
2222
})
2323
.join("\n");
2424
if summary_md.is_empty() {
25-
Ok(String::from("No summray found."))
25+
Ok(String::from("No summary found."))
2626
} else {
2727
render_for_summary(&summary_md).and_then(|md| {
2828
Ok(m2h_internal(
@@ -40,7 +40,7 @@ pub fn get_hacky_summary_md(page: &Page) -> Result<String, DocError> {
4040
/// ```html
4141
/// <p>foo</p>bar
4242
/// ```
43-
pub fn strip_paragraph_unckecked(input: &str) -> &str {
43+
pub fn strip_paragraph_unchecked(input: &str) -> &str {
4444
let out = input.trim().strip_prefix("<p>").unwrap_or(input);
4545
let out = out.trim().strip_suffix("</p>").unwrap_or(out);
4646

crates/rari-doc/src/html/rewriter.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ pub fn post_process_html<T: PageLike>(
213213
let mut curriculum_links = vec![element!("a[href^=\".\"]", |el| {
214214
let href = el.get_attribute("href").unwrap_or_default();
215215
let split_href = href.split_once('#');
216-
if let Ok(page) = CurriculumPage::page_from_realitve_file(
216+
if let Ok(page) = CurriculumPage::page_from_relative_file(
217217
page.full_path(),
218218
split_href.map(|s| s.0).unwrap_or(&href),
219219
) {

crates/rari-doc/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//! # Rari Documentation System
22
//!
33
//! The `rari_doc` crate is the central crate of the `rari` build system. It provides a robust build pipeline
4-
//! and various utilities to handle different aspects of the documentation pipline, including reading,
4+
//! and various utilities to handle different aspects of the documentation pipeline, including reading,
55
//! parsing, and rendering pages.
66
//!
77
//! ## Modules

0 commit comments

Comments
 (0)