POSYDON-code / POSYDON-code/POSYDON
[BUG]: rename "selection_function" for TransientPopulation creation
Open
Nobody has claimed this yet.
bug
documentation
enhancement
question
- Dominant language
- Python
- Stars
- 45
- Forks
- 37
- Avg merge
- 8d 20h
- Merged PRs (30d)
- 5
Description
Describe the bug
The word selection function is also within the context of detectability in the GW field. We should rename the input function name of TransientPopulation.create_transient_population() to avoid confusion.
Some ideas:
- (transient_)creation_function?
- tranformation_function?
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 at TransientPopulation.create_transient_population() and search the repository for selection_function and its callers. Choose a replacement name that distinguishes transient-population creation from detectability selection, update the references, and confirm the API no longer uses the ambiguous name.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100