diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b96bdf..bf918e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,7 +49,7 @@ git remote add upstream git@github.com:pbs-data-solutions/prelude-parser This creates the directory prelude-parser and connects your repository to the upstream (main project) repository. -Next create a vitural environment and activate it. +Next create a virtual environment and activate it. ```sh uv venv @@ -160,7 +160,7 @@ the code coverage by running: just test ``` -In additon to mainting the coverage percentage please ensure that all tests are passing before +In addition to mainting the coverage percentage please ensure that all tests are passing before submitting a pull request. ## Committing your code @@ -247,7 +247,7 @@ git fetch upstream git rebase upstream/main ``` -There may be some merge conficts that need to be resolved. After the feature branch has been update +There may be some merge conflicts that need to be resolved. After the feature branch has been update locally, you can now update your pull request by pushing to the branch on GitHub: ```sh diff --git a/README.md b/README.md index 9e03dd7..2a80391 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ data = parse_to_classes("physical_examination.xml") ``` Parse a Prelude flat XML file into a Pandas DataFrame. This works for Prelude flat XML files that -were exported with the "write tables to seperate files" option. In order to use this option +were exported with the "write tables to separate files" option. In order to use this option `prelude-parser` either needs to be installed with the `pandas` extra or the `all` extras. ```py @@ -60,7 +60,7 @@ df = to_dataframe("physical_examination.xml") ``` Parse a Prelude flat XML file into a Polars DataFrame. This works for Prelude flat XML files that -were exported with the "write tables to seperate files" option. In order to use this option +were exported with the "write tables to separate files" option. In order to use this option `prelude-parser` either needs to be installed with the `polars` extra or the `all` extras. ```py diff --git a/prelude_parser/pandas.py b/prelude_parser/pandas.py index 59375d9..d2b327b 100644 --- a/prelude_parser/pandas.py +++ b/prelude_parser/pandas.py @@ -20,7 +20,7 @@ class UnsupportedPythonVersionError(Exception): def to_dataframe(xml_file: str | Path, *, short_names: bool = False) -> pd.DataFrame: """Parse a Prelude flat XML file into a Pandas DataFrame. - This works for Prelude flat XML files that were exported with the "write tables to seperate + This works for Prelude flat XML files that were exported with the "write tables to separate files" option. Args: diff --git a/prelude_parser/polars.py b/prelude_parser/polars.py index 5850fdc..5eef714 100644 --- a/prelude_parser/polars.py +++ b/prelude_parser/polars.py @@ -15,7 +15,7 @@ def to_dataframe(xml_file: str | Path, *, short_names: bool = False) -> pl.DataFrame: """Parse a Prelude flat XML file into a Polars DataFrame. - This works for Prelude flat XML files that were exported with the "write tables to seperate + This works for Prelude flat XML files that were exported with the "write tables to separate files" option. Args: