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

[pyOpenSci review] Consider consolidating files with only one function into others #539

Closed
rich-iannone opened this issue Dec 2, 2024 · 2 comments

Comments

@rich-iannone
Copy link
Member

From the pyOpenSci comment:

issue (general): There are a fair number of files with just one pass-through function. Is this because you want to keep the codebase as close as possible to gt's, or is it just a refactoring waiting to be done?

pyOpenSci/software-submission#202 (comment)

@rich-iannone
Copy link
Member Author

rich-iannone commented Dec 12, 2024

Here's an accounting of some small .py files, categorized by what's in them.

Files with a single (unexported) function:

  • _body.py: body_reassemble()
  • _stub.py: reorder_stub_df()
  • _quarto.py: is_quarto_render()
  • utils_render_common.py: get_row_reorder_df()

Files with a single exported function:

  • _heading.py: tab_header()
  • _pipe.py: pipe()
  • _source_notes.py: tab_source_note()
  • _stubhead.py: tab_stubhead()

Short files with types:

  • _types.py
  • loc.py
  • style.py
  • vals.py

'Empty' files

  • _footnotes.py
  • _row_groups.py

@machow
Copy link
Collaborator

machow commented Dec 12, 2024

I think that modules like _quarto.py are there to signal a very explicit layer to an external tool. It looks like some of the others could be refactored (e.g. body_reassemble() is a passthrough function). I'm going to close, but we'll need get around to cleaning some of this up 😓

@machow machow closed this as not planned Won't fix, can't repro, duplicate, stale Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants