Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor flow for easier access to some files (avoid things like jrnl.Journal.Journal and jrnl.jrnl co-existing) #1662

Merged
merged 6 commits into from
Jan 14, 2023

Conversation

wren
Copy link
Member

@wren wren commented Jan 11, 2023

This fixes a few issues with file naming in the codebase. Mainly, we want to avoid things like jrnl.Journal.Journal co-existing with jrnl.jrnl because it leads to a lot of confusion when talking about the code, and for new contributors. This doesn't fix everything, but gets the ball rolling on some quality-of-life fixes.

  • rename cli.py to main.py
  • rename jrnl.py to controller.py
  • move journal class files into journals dir

Checklist

  • I have read the contributing doc.
  • I have included a link to the relevant issue number.
  • I have checked to ensure there aren't other open pull requests
    for the same issue.
  • I have written new tests for these changes, as needed.

Copy link
Member

@micahellison micahellison left a comment

Choose a reason for hiding this comment

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

Finally, no more confusing jrnl.py with Journal.py while speaking out loud! Thanks for doing this.

@micahellison micahellison added the enhancement New feature or request label Jan 14, 2023
@micahellison micahellison merged commit fff05eb into jrnl-org:develop Jan 14, 2023
@micahellison micahellison deleted the flow-rework-2 branch January 14, 2023 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants