lasp / lasp/latis-python-client

Rename Dataset getFile function

Open
#6 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

"Get" suggests accessing something that is already there. We, instead, want to create a new file. writeFile is one option we could discuss. We could also consider specific functions like writeCSV. Consider python idioms and other precedence (e.g. python uses "write"). There's also a similarity with our asX functions for transforming a Dataset into a different in-memory data structure. Transforming a Dataset into a file is a similar concept which might suggest some consistent API decisions.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Dataset getFile function and its usages. Compare the proposed writeFile and writeCSV names with Python naming idioms and the existing asX API, then settle on a consistent replacement before identifying all references that must be updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.