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

Improve Arb function naming #2310

Merged
merged 3 commits into from
Jun 20, 2021
Merged

Improve Arb function naming #2310

merged 3 commits into from
Jun 20, 2021

Conversation

BartvHelvert
Copy link
Contributor

@BartvHelvert BartvHelvert commented Jun 2, 2021

Improves the naiming of some of the Arb functions to be more idiomatic. The following names are changed:

  • bool -> boolean
  • edgecase -> edgeCase
  • ubyte -> uByte, ushort -> uShort etc...

Also fixes some typos in genslist.md and fixed deprecation replacements.

Closes #2305.

Changes bool to boolean, edgecase to edgecases and uprim to uPrim.
@sksamuel
Copy link
Member

I can get behind the types changing, but please add deprecated forwarding methods or type aliases.
Also I don't think we should rename edgecases. We only just went through a round of deprecations and changes on the way edgecases work and I think it's ambiguous whether its one word or two anyway.

@BartvHelvert
Copy link
Contributor Author

I can get behind the types changing, but please add deprecated forwarding methods or type aliases.

I think all of them have deprecation forward methods? The methods that don't have it didn't exist in 4.6.0 so I don't think it is worth adding deprecation warnings for those methods. If you think I missed some, let me know.

Also I don't think we should rename edgecases. We only just went through a round of deprecations and changes on the way edgecases work and I think it's ambiguous whether its one word or two anyway.

I can't find any usage of edgecase as a single word online so I don't think it is really ambiguous. But if it is to much of a breaking change I will remove it from this PR.

@sksamuel
Copy link
Member

I can get behind the types changing, but please add deprecated forwarding methods or type aliases.

I think all of them have deprecation forward methods? The methods that don't have it didn't exist in 4.6.0 so I don't think it is worth adding deprecation warnings for those methods. If you think I missed some, let me know.

Ah ok I must have missed them first time around. I see them now.

Also I don't think we should rename edgecases. We only just went through a round of deprecations and changes on the way edgecases work and I think it's ambiguous whether its one word or two anyway.

I can't find any usage of edgecase as a single word online so I don't think it is really ambiguous. But if it is to much of a breaking change I will remove it from this PR.

Yeah you're probably right but I feel like it's one of those words in English that works both ways. Either way, I'm reluctant to change it again after we just changed it in 4.4.0. For something that most people won't use directly, I feel the benefit is low.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Arb naming
2 participants