Skip to content

Conversation

@ehanson8
Copy link
Contributor

Purpose and background context

Updates app according to our maintenance week documentation.

How can a reviewer manually see the effects of these changes?

Run make test and make lint to confirm they still pass

Includes new or updated dependencies?

YES

Changes expectations for external applications?

NO

What are the relevant tickets?

NA

Developer

  • All new ENV is documented in README
  • All new ENV has been added to staging and production environments
  • All related Jira tickets are linked in commit message(s)
  • Stakeholder approval has been confirmed (or is not needed)

Code Reviewer(s)

  • The commit message is clear and follows our guidelines (not just this PR message)
  • There are appropriate tests covering any new functionality
  • The provided documentation is sufficient for understanding any new functionality introduced
  • Any manual tests have been performed and verified
  • New dependencies are appropriate or there were no changes

Comment on lines +41 to +43
def ntransfercmd(
self, cmd: str, rest: str | int | None = None
) -> tuple[socket, int | None]:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was confused by this at first but it looks like the type hint was indeed updated, see #4 here

Copy link
Contributor

Choose a reason for hiding this comment

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

Nice find! Helpful to understand why it changed.

Copy link
Contributor

@ghukill ghukill left a comment

Choose a reason for hiding this comment

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

Approved! Thanks for the note about type hints changing. Looks great all around, and agreed that the maintenance work is starting to establish a nice foundation.

Comment on lines +41 to +43
def ntransfercmd(
self, cmd: str, rest: str | int | None = None
) -> tuple[socket, int | None]:
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice find! Helpful to understand why it changed.

def _add_subelement(
self,
parent: ET._Element, # noqa: SLF001
parent: ET._Element,
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor, but always appreciate when we can remove linting overrides / ignores.

Copy link
Contributor

@jonavellecuerdo jonavellecuerdo left a comment

Choose a reason for hiding this comment

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

Code updates look good to me! 😄 One small change request is for the README. Can you update the environment variables section to the format:


Environment Variables

Required

<ENV_VAR>=# <Description>.
<ENV_VAR>=# <Description>.

Optional

<ENV_VAR>=# <Description>.
<ENV_VAR>=# <Description>.

@ehanson8 ehanson8 merged commit 73f7266 into main Aug 7, 2024
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