Skip to content

A few reference-related renamings#237

Merged
alexdewar merged 2 commits intomainfrom
rename-refs
May 1, 2025
Merged

A few reference-related renamings#237
alexdewar merged 2 commits intomainfrom
rename-refs

Conversation

@alexdewar
Copy link
Copy Markdown
Collaborator

Noticed this while I was working on something else... The function is called get_reference even though it returns multiple references. And the file is called references.py (plural) when we've used singular names for the other files (e.g. section.py). Fix this.

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 renames the function and module for handling references to adhere to our naming conventions.

  • Updated test cases to import get_references from autocorpus/reference.
  • Changed the import and invocation in section.py to use get_references.
  • Renamed the function in reference.py from get_reference to get_references.

Reviewed Changes

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

File Description
tests/test_reference.py Updated import and assertion to match the new function name.
autocorpus/section.py Updated the reference import and the yield call accordingly.
autocorpus/reference.py Renamed the function definition to get_references.
Comments suppressed due to low confidence (1)

autocorpus/reference.py:7

  • [nitpick] The function name get_references implies it might return multiple references, yet it returns a single reference dictionary. Consider updating the docstring to clarify that the function returns a single structured reference or adjust the function name if multiple references are expected.
def get_references(reference: dict[str, Any], section_heading: str) -> dict[str, Any]:

Copy link
Copy Markdown
Collaborator

@Thomas-Rowlands Thomas-Rowlands left a comment

Choose a reason for hiding this comment

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

LGTM

@alexdewar alexdewar merged commit 1f8f75d into main May 1, 2025
14 checks passed
@alexdewar alexdewar deleted the rename-refs branch May 1, 2025 08:42
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