From f2adeeeab406934cf47187ea278e20894f45c5dc Mon Sep 17 00:00:00 2001 From: LuanRT Date: Sun, 1 Jan 2023 23:04:04 -0300 Subject: [PATCH] docs: rephrasing --- README.md | 2 +- docs/updating-the-parser.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 123958eb..9900e170 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ ___ ## Description -InnerTube is an API used across all YouTube clients. It was created to simplify the deployment of new features and experiments across the platform[^1]. This library handles all the low-level communication with InnerTube, providing a simple, and efficient way to interact with YouTube programmatically. It is designed to emulate an actual client as closely as possible, including how API responses are parsed. +InnerTube is an API used by all YouTube clients. It was created to simplify the deployment of new features and experiments across the platform[^1]. This library handles all the low-level communication with InnerTube, providing a simple, and efficient way to interact with YouTube programmatically. It is designed to emulate an actual client as closely as possible, including how API responses are [parsed](https://github.com/LuanRT/YouTube.js/tree/main/src/parser#how-it-works). If you have any questions or need help, feel free to reach out to us on our [Discord server][discord] or open an issue [here](https://github.com/LuanRT/YouTube.js/issues). diff --git a/docs/updating-the-parser.md b/docs/updating-the-parser.md index ec80e8d1..b392f712 100644 --- a/docs/updating-the-parser.md +++ b/docs/updating-the-parser.md @@ -2,7 +2,7 @@ YouTube is constantly changing, so it is not rare to see YouTube crawlers/scrapers breaking every now and then. -Our parser, on the other hand, was written so that it behaves similarly to an official client, parsing and mapping renderers (a.k.a YTNodes) dynamically without hard-coding their path in the response. This way, whenever a new renderer pops up (e.g; YouTube adds a new feature / minor UI changes) the library will print a warning like this in the console: +Our parser, on the other hand, was written so that it behaves similarly to an official client, parsing and mapping renderers (a.k.a YTNodes) dynamically without hard-coding their path in the response. This way, whenever a new renderer pops up (e.g; YouTube adds a new feature / minor UI changes) the library will print a warning similar to this: ``` InnertubeError: SomeRenderer not found! This is a bug, want to help us fix it? Follow the instructions at https://github.com/LuanRT/YouTube.js/blob/main/docs/updating-the-parser.md or report it at https://github.com/LuanRT/YouTube.js/issues! @@ -17,7 +17,7 @@ This is a bug, want to help us fix it? Follow the instructions at https://github } ``` -This warning, however, **does not** throw an error. The parser itself will continue working normally, even if a parsing error occurs in an existing renderer parser. +This warning **does not** throw an error. The parser itself will continue working normally, even if a parsing error occurs in an existing renderer parser. ## Adding a new renderer parser