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.

Sign up for GitHub

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

Jump to bottom

Force named arguments for spec methods #14759

Open
straight-shoota opened this issue Jun 26, 2024 · 3 comments · May be fixed by #14915
Open

Force named arguments for spec methods #14759

straight-shoota opened this issue Jun 26, 2024 · 3 comments · May be fixed by #14915
Labels
good first issue This is an issue suited for newcomers to become aquianted with working on the codebase. help wanted This issue is generally accepted and needs someone to pick it up kind:chore status:discussion topic:stdlib:specs

Comments

@straight-shoota
Copy link
Member

Spec methods like describe, it, etc. accept a number of positional parameters. Only the first one, description is really a good positional parameter. The others are options which should be passed as named arguments. Without a name there's no intuitive understanding what order the parameters would go in (did you know the second one is file?, ref #14757).

We should force all parameters after description to be named arguments.
@straight-shoota straight-shoota added good first issue This is an issue suited for newcomers to become aquianted with working on the codebase. kind:chore help wanted This issue is generally accepted and needs someone to pick it up labels Aug 7, 2024
@kamil-gwozdz kamil-gwozdz linked a pull request Aug 17, 2024 that will close this issue
Draft
@CTC97
Copy link

CTC97 commented Oct 17, 2024

Is this issue relevant anymore?

@Blacksmoke16
Copy link
Member

I'd say yes. The existing PR has suggestions that are pending @kamil-gwozdz to address. I'm not sure what our process is for taking over an old PR, but would probably be fine to branch off their work, address the feedback, and open a new PR. This way you'd both get credit for the PR since it would use both of your commits.

@kamil-gwozdz
Copy link
Contributor

Hey, sorry for the delay. I just came back from a longer vacation. I'll probably won't have time to work on it this or next week but feel to branch off or just cherry-pick the relevant commits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue This is an issue suited for newcomers to become aquianted with working on the codebase. help wanted This issue is generally accepted and needs someone to pick it up kind:chore status:discussion topic:stdlib:specs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

use named arguments in spec methods kamil-gwozdz/crystal
4 participants
@straight-shoota @Blacksmoke16 @CTC97 @kamil-gwozdz