Skip to content
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.

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

fix(docs/etc): Fix miscellaneous typos #837

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ In the example below, the graph has one node. The `checkpointer` parameter in Pr
Invocation 1:

1. When the graph is invoked with `2`, `input` channels value becomes `2`
2. Node `one` runs because it is subscribed to `input`. The node tranforms `2` to `2` by running `inputPlusTotal`.
2. Node `one` runs because it is subscribed to `input`. The node transforms `2` to `2` by running `inputPlusTotal`.
3. The value of channels `output` and `total` get set to `2` because node `one` writes to both channels
4. Because `memory` is passed into the graph, `total` at thread_id of `1` is saved as a value of `2`
5. The graph ends with `output`'s value which is `2`
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/concepts/double_texting.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ See the [how-to guide](/langgraphjs/cloud/how-tos/interrupt_concurrent) for conf
This option rolls back all work done up until that point.
It then sends the user input in, basically as if it just followed the original run input.

This may create some weird states - for example, you may have two `User` messages in a row, with no `Asssitant` message in between them.
This may create some weird states - for example, you may have two `User` messages in a row, with no `Assistant` message in between them.

You will need to make sure the LLM you are calling can handle that, or combine those into a single `User` message.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/workflows/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ const multiply = tool(
},
{
name: "multiply",
description: "mutiplies two numbers together",
description: "multiplies two numbers together",
schema: z.object({
a: z.number("the first number"),
b: z.number("the second number"),
Expand Down
4 changes: 2 additions & 2 deletions libs/checkpoint-mongodb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ const checkpoint = {
channel_versions: {
__start__: 2,
my_key: 3,
start:node: 3,
"start:node": 3,
node: 3
},
versions_seen: {
Expand All @@ -44,7 +44,7 @@ const checkpoint = {
__start__: 1
},
node: {
start:node: 2
"start:node": 2
}
},
pending_sends: [],
Expand Down
4 changes: 2 additions & 2 deletions libs/checkpoint-postgres/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ const checkpoint = {
channel_versions: {
__start__: 2,
my_key: 3,
start:node: 3,
"start:node": 3,
node: 3
},
versions_seen: {
Expand All @@ -44,7 +44,7 @@ const checkpoint = {
__start__: 1
},
node: {
start:node: 2
"start:node": 2
}
},
pending_sends: [],
Expand Down
4 changes: 2 additions & 2 deletions libs/checkpoint-postgres/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -237,10 +237,10 @@ export class PostgresSaver extends BaseCheckpointSaver {
}

/**
* Return WHERE clause predicates for alist() given config, filter, cursor.
* Return WHERE clause predicates for a given list() config, filter, cursor.
*
* This method returns a tuple of a string and a tuple of values. The string
* is the parametered WHERE clause predicate (including the WHERE keyword):
* is the parameterized WHERE clause predicate (including the WHERE keyword):
* "WHERE column1 = $1 AND column2 IS $2". The list of values contains the
* values for each of the corresponding parameters.
*/
Expand Down
4 changes: 2 additions & 2 deletions libs/checkpoint-sqlite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const checkpoint = {
channel_versions: {
__start__: 2,
my_key: 3,
start:node: 3,
"start:node": 3,
node: 3
},
versions_seen: {
Expand All @@ -40,7 +40,7 @@ const checkpoint = {
__start__: 1
},
node: {
start:node: 2
"start:node": 2
}
},
pending_sends: [],
Expand Down
4 changes: 2 additions & 2 deletions libs/checkpoint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ const checkpoint = {
channel_versions: {
__start__: 2,
my_key: 3,
start:node: 3,
"start:node": 3,
node: 3
},
versions_seen: {
Expand All @@ -77,7 +77,7 @@ const checkpoint = {
__start__: 1
},
node: {
start:node: 2
"start:node": 2
}
},
pending_sends: [],
Expand Down
2 changes: 1 addition & 1 deletion libs/langgraph/src/tests/channels.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ describe("AnyValue", () => {
});
});

describe("EphemeralValue with gaurd: false", () => {
describe("EphemeralValue with guard: false", () => {
it("should handle ephemeral value correctly", () => {
const channel = new EphemeralValue<number>(false);

Expand Down
8 changes: 4 additions & 4 deletions libs/langgraph/src/tests/func.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ export function runFuncTests(
expect(() =>
entrypoint(
{ name: "graph", checkpointer },
// we need ts-expect-error here because the type system also gaurds against this
// we need ts-expect-error here because the type system also guards against this
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-expect-error
function* () {
Expand All @@ -374,7 +374,7 @@ export function runFuncTests(
expect(() =>
entrypoint(
{ name: "graph", checkpointer },
// we need ts-expect-error here because the type system also gaurds against this
// we need ts-expect-error here because the type system also guards against this
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-expect-error
async function* () {
Expand All @@ -392,7 +392,7 @@ export function runFuncTests(
expect(() =>
task(
"task",
// we need ts-expect-error here because the type system also gaurds against this
// we need ts-expect-error here because the type system also guards against this
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-expect-error
function* () {
Expand All @@ -409,7 +409,7 @@ export function runFuncTests(
expect(() =>
task(
"task",
// we need ts-expect-error here because the type system also gaurds against this
// we need ts-expect-error here because the type system also guards against this
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-expect-error
async function* () {
Expand Down
2 changes: 1 addition & 1 deletion libs/langgraph/src/tests/pregel.read.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ describe("PregelNode", () => {
});

describe("getNode", () => {
it("should return undefined if bound is default andthere are no writers", () => {
it("should return undefined if bound is default and there are no writers", () => {
// set up test
const pregelNode = new PregelNode({
channels: ["foo"],
Expand Down
6 changes: 3 additions & 3 deletions libs/langgraph/src/tests/pregel.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6240,7 +6240,7 @@ graph TD;
const { store } = config;
expect(store).toBeDefined();
if (!store) {
throw new Error("No store foubd");
throw new Error("No store found");
}

expect(config.configurable?.assistant_id).toEqual("a");
Expand All @@ -6260,7 +6260,7 @@ graph TD;
const { store } = config;
expect(store).toBeDefined();
if (!store) {
throw new Error("No store foubd");
throw new Error("No store found");
}

expect(config.configurable?.assistant_id).toEqual("a");
Expand Down Expand Up @@ -6414,7 +6414,7 @@ graph TD;

// below combo of assertions is asserting two things
// - outer_1 finishes before inner interrupts (because we see its output in stream, which only happens after node finishes)
// - the writes of outer are persisted in 1st call and used in 2nd call, ie outer isn't called again (because we dont see outer_1 output again in 2nd stream)
// - the writes of outer are persisted in 1st call and used in 2nd call, ie outer isn't called again (because we don't see outer_1 output again in 2nd stream)
// test stream updates w/ nested interrupt
const config2 = { configurable: { thread_id: "2" } };

Expand Down