tee-ar-ex / tee-ar-ex/trx-python
Rename the confusing object name TrxFile ?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 20
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 9
Description
Hi trx team
TrxFile is a disturbing object since you expect or believe to have a filename, filepath, etc...
I propose to rename this object TrxContainer, TrxHolder, etc....
I am open to any other renaming but I strongly believe that TrxFile is very confusing.
concatenate function is a nice exemple. When you see TrxFile as an input of this function, I believed that I need to put a filename, however, in reality, you need to load it before calling the function.
Please, let me know what you think @frheault and @arokem
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the TrxFile object and the concatenate function, which the issue identifies as the confusing API surface. Determine the intended replacement name with the maintainers, then trace the impact of that naming decision through the project. Done means the new name and migration scope are agreed and consistently applied.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100