[Chore] Fix typos, and organize functions for style #1087

miguelcsx · 2024-10-23T05:56:26Z

Description

This PR addresses the following non-functional maintenance tasks:

Fixed various typos in the code and comments.
Reorganized some functions to improve style and readability, following code style guidelines.

No functional changes have been made in this PR. The main objective is to improve the maintainability and clarity of the code.

Closes #1086

Important

Cleaned up unused imports, fixed typos, and reorganized functions for improved code style and readability.

Imports:
- Removed unused imports in to_baml_arg.rs, json_schema.rs, repr.rs, chat_message_part.rs, array_helper.rs, coerce_optional.rs, field_type.rs, coerce_class.rs, match_string.rs, types.rs, iterative_parser.rs, parse_state.rs, raw_value.rs, test_iterative_parser.rs, fixing_parser.rs, json_collection.rs, json_parse_state.rs, value.rs, lib.rs, api_interface.rs, core_types.rs, mod.rs, threaded_tracer.rs, harness.rs, test_runtime.rs, runtime_wasm.rs, generate_types.rs, mod.rs, parse_py_type.rs, runtime.rs, baml_example_app.py.
Typos:
- Fixed typos in CHANGELOG.md, README.md, to_baml_arg.rs, json_schema.rs, repr.rs, types.rs, comments.rs, misspeled_boolean_literals.baml, valid_dictionary.baml, shorthand_clients.baml, failing_tests.baml, valid_tests.baml, valid.baml, baml_value_to_jinja_value.rs, chat_message_part.rs, lib.rs, api_interface.rs, core_types.rs, mod.rs, threaded_tracer.rs, harness.rs, test_runtime.rs, runtime_wasm.rs, generate_types.rs, mod.rs, parse_py_type.rs, runtime.rs, baml_example_app.py.
Reorganization:
- Reorganized functions for better style and readability in to_baml_arg.rs, json_schema.rs, repr.rs, chat_message_part.rs, array_helper.rs, coerce_optional.rs, field_type.rs, coerce_class.rs, match_string.rs, types.rs, iterative_parser.rs, parse_state.rs, raw_value.rs, test_iterative_parser.rs, fixing_parser.rs, json_collection.rs, json_parse_state.rs, value.rs, lib.rs, api_interface.rs, core_types.rs, mod.rs, threaded_tracer.rs, harness.rs, test_runtime.rs, runtime_wasm.rs, generate_types.rs, mod.rs, parse_py_type.rs, runtime.rs, baml_example_app.py.

^{This description was created by}^{for 825d39e. It will automatically update as commits are pushed.}

vercel · 2024-10-23T05:56:29Z

@miguelcsx is attempting to deploy a commit to the Gloo Team on Vercel.

A member of the Team first needs to authorize it.

ellipsis-dev

👍 Looks good to me! Reviewed everything up to 825d39e in 46 seconds

More details

Looked at 1960 lines of code in 86 files
Skipped 0 files when reviewing.
Skipped posting 1 drafted comments based on config settings.

1. integ-tests/python/baml_example_app.py:26

Draft comment:
Typo in 'parsable'. It should be 'parsable'.
Reason this comment was not posted:
Confidence changes required: 50%
The PR description mentions fixing typos, and there is a typo in the word 'parsable' which should be 'parsable'.

Workflow ID: wflow_y9qTlou2pZadm1H8

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

- fixed typos in code and comments - reorganized function for improved readability and style

hellovai · 2024-10-23T16:29:33Z

will pause this until #1006 is merged in

sxlijin

@miguelcsx if you're still interested in getting this PR in, you're welcome to pick it back up now! There's probably a whole bunch of merge conflicts that you'll need to address, you might need to redo this from scratch.

sxlijin · 2024-12-05T17:46:40Z

engine/baml-lib/jinja/src/evaluate_type/types.rs

@@ -304,7 +304,7 @@ impl PredefinedTypes {
        };

        // Any vars that are in both branches are merged
-        // Any vars that are only in one branch, unioned with undefined
+        // Any vars that are only in one branch, united with undefined


Suggested change

// Any vars that are only in one branch, united with undefined

// Any vars that are only in one branch, unioned with undefined

"unioned" is technically an invalid word but is deliberately used here to reference type unions

sxlijin · 2024-12-05T17:47:36Z

engine/baml-lib/jsonish/src/deserializer/coercer/coerce_optional.rs

@@ -32,7 +32,7 @@ pub(super) fn coerce_optional(
        Some(v) => match inner.coerce(ctx, optional_target, Some(v)) {
            Ok(v) => Ok(v),
            Err(e) => {
-                flags.add_flag(Flag::DefaultButHadUnparseableValue(e));
+                flags.add_flag(Flag::DefaultButHadUnparsableValue(e));


Suggested change

flags.add_flag(Flag::DefaultButHadUnparsableValue(e));

flags.add_flag(Flag::DefaultButHadUnparseableValue(e));

both "parseable" and "parsable" are valid spellings, but the former will show up when grepping/searching for "parse"

sxlijin · 2024-12-05T17:48:19Z

engine/baml-lib/jsonish/src/deserializer/deserialize_flags.rs

+            Flag::DefaultButHadUnparsableValue(value) => {
+                write!(f, "Null but had unparsable value")?;


unparseable

sxlijin · 2024-12-05T17:48:54Z

engine/baml-lib/jsonish/src/tests/test_basics.rs

@@ -320,7 +320,7 @@ test_deserializer!(

 // This is un-changed
 test_deserializer!(
-    test_prefixed_incompleted_string,
+    test_prefixed_incompletestring,


Suggested change

test_prefixed_incompletestring,

test_prefixed_incomplete_string,

sxlijin · 2024-12-05T17:50:05Z

engine/baml-lib/schema-ast/src/parser/parse_schema.rs

@@ -156,7 +156,7 @@ pub fn parse_schema(
                pest::error::ErrorVariant::ParsingError { positives, .. } => {
                    get_expected_from_error(&positives)
                }
-                _ => panic!("Could not construct parsing error. This should never happend."),
+                _ => panic!("Could not construct parsing error. This should never happened."),


Suggested change

_ => panic!("Could not construct parsing error. This should never happened."),

_ => panic!("Could not construct parsing error. This should never happen."),

sxlijin · 2024-12-05T17:50:27Z

engine/baml-runtime/build.rs

-    println!("");
-    println!("Please install mise and direnv to build BAML (instructions: https://www.notion.so/gloochat/To-build-BAML-0e9e3e9b583e40fb8fb040505b24d65f )");
-    println!("");
+    println!("\nPlease install mise and direnv to build BAML (instructions: https://www.notion.so/gloochat/To-build-BAML-0e9e3e9b583e40fb8fb040505b24d65f )\n");


undo this change, separate println's are deliberate

sxlijin · 2024-12-05T17:51:14Z

engine/baml-runtime/src/lib.rs

-#[cfg(not(feature = "internal"))]
-pub(crate) use internal_baml_jinja::{ChatMessagePart, RenderedPrompt};


restore this, i don't trust this change

sxlijin · 2024-12-05T17:51:30Z

engine/baml-runtime/src/lib.rs

@@ -382,7 +380,7 @@ impl BamlRuntime {
                    // generating code, run 'baml-cli dev' to generate code" because that's surprising
                    //
                    // We _could_ do something like "show that message the first time the user tries to
-                    // codegen for rest/openapi", but that's overengineered, I think
+                    // codegen for rest/openapi", but that's over engineered, I think


Suggested change

// codegen for rest/openapi", but that's over engineered, I think

// codegen for rest/openapi", but that's overengineered, I think

sxlijin · 2024-12-05T17:51:53Z

engine/baml-schema-wasm/nodejs/README.md

@@ -22,7 +22,7 @@ node -e "const prismaSchema = require('@prisma/prisma-schema-wasm'); console.log
    - It is triggered from the https://github.com/prisma/engines-wrapper publish action.
 - The [Rust source code](https://github.com/prisma/prisma-engines/tree/main/prisma-schema-wasm/src) for the wasm module
 - The [nix build definition](https://github.com/prisma/prisma-engines/blob/main/prisma-schema-wasm/default.nix)
-    - It gives us a fully reproducible, thoroughly described build process and environment. The alternative would be a bash script with installs through `rustup`, `cargo install` and `apt`, with underspecified system dependencies and best-effort version pinning.
+    - It gives us a fully reproducible, thoroughly described build process and environment. The alternative would be a bash script with installs through `rustup`, `cargo install` and `apt`, with under specified system dependencies and best-effort version pinning.


Suggested change

- It gives us a fully reproducible, thoroughly described build process and environment. The alternative would be a bash script with installs through `rustup`, `cargo install` and `apt`, with under specified system dependencies and best-effort version pinning.

- It gives us a fully reproducible, thoroughly described build process and environment. The alternative would be a bash script with installs through `rustup`, `cargo install` and `apt`, with underspecified system dependencies and best-effort version pinning.

ellipsis-dev bot reviewed Oct 23, 2024

View reviewed changes

chore: BoundaryML#1086 fix typos, and organize style

7533516

- fixed typos in code and comments - reorganized function for improved readability and style

miguelcsx force-pushed the chore/typos branch from 825d39e to 7533516 Compare October 23, 2024 06:21

miguelcsx changed the title ~~[Chore] Clean up unused imports, fix typos, and organize functions for style~~ [Chore] Fix typos, and organize functions for style Oct 23, 2024

sxlijin reviewed Dec 5, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Chore] Fix typos, and organize functions for style #1087

[Chore] Fix typos, and organize functions for style #1087

miguelcsx commented Oct 23, 2024 •

edited

Loading

vercel bot commented Oct 23, 2024

ellipsis-dev bot left a comment

hellovai commented Oct 23, 2024

sxlijin left a comment

sxlijin Dec 5, 2024

sxlijin Dec 5, 2024

sxlijin Dec 5, 2024

sxlijin Dec 5, 2024

sxlijin Dec 5, 2024

sxlijin Dec 5, 2024

sxlijin Dec 5, 2024

sxlijin Dec 5, 2024

sxlijin Dec 5, 2024

	// Any vars that are only in one branch, united with undefined
	// Any vars that are only in one branch, unioned with undefined

	flags.add_flag(Flag::DefaultButHadUnparsableValue(e));
	flags.add_flag(Flag::DefaultButHadUnparseableValue(e));

		Flag::DefaultButHadUnparsableValue(value) => {
		write!(f, "Null but had unparsable value")?;

	test_prefixed_incompletestring,
	test_prefixed_incomplete_string,

	_ => panic!("Could not construct parsing error. This should never happened."),
	_ => panic!("Could not construct parsing error. This should never happen."),

		#[cfg(not(feature = "internal"))]
		pub(crate) use internal_baml_jinja::{ChatMessagePart, RenderedPrompt};

	// codegen for rest/openapi", but that's over engineered, I think
	// codegen for rest/openapi", but that's overengineered, I think

	- It gives us a fully reproducible, thoroughly described build process and environment. The alternative would be a bash script with installs through `rustup`, `cargo install` and `apt`, with under specified system dependencies and best-effort version pinning.
	- It gives us a fully reproducible, thoroughly described build process and environment. The alternative would be a bash script with installs through `rustup`, `cargo install` and `apt`, with underspecified system dependencies and best-effort version pinning.

[Chore] Fix typos, and organize functions for style #1087

Are you sure you want to change the base?

[Chore] Fix typos, and organize functions for style #1087

Conversation

miguelcsx commented Oct 23, 2024 • edited Loading

Description

vercel bot commented Oct 23, 2024

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

hellovai commented Oct 23, 2024

sxlijin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miguelcsx commented Oct 23, 2024 •

edited

Loading