Conversation
Contributor
There was a problem hiding this comment.
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]:
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Noticed this while I was working on something else... The function is called
get_referenceeven though it returns multiple references. And the file is calledreferences.py(plural) when we've used singular names for the other files (e.g.section.py). Fix this.