AlgebraicJulia / GATlab.jl

GATlab: a computer algebra system based on generalized algebraic theories (GATs)
https://algebraicjulia.github.io/GATlab.jl/
MIT License
21 stars 2 forks source link

Trivial docs edits and rename `@migrate` #126

Closed KevinDCarlson closed 8 months ago

KevinDCarlson commented 8 months ago

I thought we'd agreed to name @migrate something different to avoid collision with DataMigrations, so renamed it here, I don't think we want the DataMigrations one to be a method of the Gatlab one. Also a couple of superficial edits to docs. Let me know any thoughts.

codecov[bot] commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (345cc44) 96.61% compared to head (b885d2d) 96.61%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #126 +/- ## ======================================= Coverage 96.61% 96.61% ======================================= Files 38 38 Lines 2067 2067 ======================================= Hits 1997 1997 Misses 70 70 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

kris-brown commented 8 months ago

With https://github.com/AlgebraicJulia/GATlab.jl/pull/118, migrate is now a function, not a macro! Would this make things compatible with DataMigrations?

KevinDCarlson commented 8 months ago

I guess so, right? That's exporting @migrate and migrate, which don't collide. I'm still skeptical about having both of those names present and meaning dramatically different things, in terms of UX. It seems like a pretty common Julian practice to have @f be a sugared version of f.

KevinDCarlson commented 8 months ago

Err, wait...Then I have to think about migrate itself in DataMigrations. That's exported too and we don't want to have those collide either.

epatters commented 8 months ago

My suggestion would still be to have migrate_model and/or @migrate_model. It's only a few more characters but IMO makes it notably more clear what the function/macro does.

kris-brown commented 8 months ago

Great, I updated that PR!