Skip to content

fixes typo in docstrings#241

Merged
tomjemmett merged 1 commit intomainfrom
fix_docstring_typo
Mar 31, 2026
Merged

fixes typo in docstrings#241
tomjemmett merged 1 commit intomainfrom
fix_docstring_typo

Conversation

@tomjemmett
Copy link
Copy Markdown
Member

used Spark context, when it is actually the spark session

@tomjemmett tomjemmett requested a review from a team as a code owner March 31, 2026 14:19
Copilot AI review requested due to automatic review settings March 31, 2026 14:19
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR corrects docstring parameter descriptions across the nhp.data Spark ETL/data-access modules, clarifying that the spark parameter is a SparkSession (not a Spark context).

Changes:

  • Updated :param spark: docstring text from “Spark context” to “Spark session” in multiple functions to match the actual SparkSession type hints.

Reviewed changes

Copilot reviewed 37 out of 37 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/nhp/data/reference/population_by_imd_decile.py Docstring clarifies spark is a Spark session.
src/nhp/data/reference/icb_catchments.py Docstrings updated to refer to Spark session for spark param.
src/nhp/data/population_projections/npp.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/nhp_datasets/providers.py Docstrings updated to refer to Spark session for spark param.
src/nhp/data/nhp_datasets/local_authorities.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/nhp_datasets/icbs.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/model_data/op.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/model_data/ip.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/model_data/inequalities.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/model_data/demographic_factors.py Docstrings updated to refer to Spark session for spark param.
src/nhp/data/model_data/birth_factors.py Docstrings updated to refer to Spark session for spark param.
src/nhp/data/model_data/aae.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/rates.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/procedures.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/op/rates.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/op/procedures.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/op/expat_repat.py Docstrings updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/op/diagnoses.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/op/baseline.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/op/init.py Docstrings updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/ip/rates.py Docstrings updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/ip/procedures.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/ip/expat_repat.py Docstrings updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/ip/diagnoses.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/ip/baseline.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/ip/init.py Docstrings updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/inequalities.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/expat_repat.py Docstrings updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/diagnoses.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/baseline.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/ae/rates.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/ae/procedures.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/ae/expat_repat.py Docstrings updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/ae/diagnoses.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/ae/baseline.py Docstring updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/ae/init.py Docstrings updated to refer to Spark session for spark param.
src/nhp/data/inputs_data/acute_providers.py Docstrings updated to refer to Spark session for spark param.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@tomjemmett tomjemmett merged commit 200068d into main Mar 31, 2026
7 checks passed
@tomjemmett tomjemmett deleted the fix_docstring_typo branch March 31, 2026 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants