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

Code formatting and structuring #16

Open
lynnpepin opened this issue Nov 1, 2022 · 3 comments
Open

Code formatting and structuring #16

lynnpepin opened this issue Nov 1, 2022 · 3 comments

Comments

@lynnpepin
Copy link
Contributor

With this issue, we should have some changes to code format and structure (and establish a style for the project).

A few changes to expect:

  • Imports before code
  • Snake-case variable names
  • No single-character names
  • Multi-line strings in place of comments
  • Tests outside code (except for oneliners, asserts).

Outside the scope of this issue, but other related changes to keep in mind:

  • Sphinx-RTD format docstrings. (Good for generating documentation without maintaining eparate docs.)
  • Robust tokenizer for various CSV-esques. (SpaCy for NLP if we need something extreme.)
  • Find alternative to yamale?
  • Make UTF-8 standard.
  • Document usage under python -i foobar.py
  • Use Jupyter Notebooks for interactivity, where applicable.
@Jbutler-helpful
Copy link
Collaborator

I like the idea of Jupyter Notebooks for interactivity

@Jbutler-helpful
Copy link
Collaborator

@devhawk can you review this, I suspect this sort of stuff should end up in the Readme or in a specific style guide.

@Jbutler-helpful
Copy link
Collaborator

@devhawk this issue is resolve correct

Is the best practice documented sufficiently in the readme

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

2 participants