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

Refactoring with breaking changes for more consistent naming in API #35

Closed
GoogleCodeExporter opened this issue Jun 21, 2015 · 3 comments

Comments

Projects
None yet
1 participant
@GoogleCodeExporter
Copy link

commented Jun 21, 2015

There are a handful of API naming breaking changes we should like to undertake 
for the upcoming Unquote version 2.0.0 release where we feel the benefit 
outweighs the cost, the first is the most significant
  1. Rename `Swensen.Unquote.Operators.source` and the extension method `Expr.ToSource()` to `Swensen.Unquote.Operators.decompile` and `Expr.Decompile()` respectively. We feel this will be a more consistent renaming among the `eval` and `reduce` operators and will not impact folks who are only using Unquote for its main intended purpose as a unit testing assertion library.
  2. Consolidate `Swensen.Unquote.ExprExt` and `Swensen.Unquote.TypeExt` into `Swensen.Unquote.Extensions`. Since these are all AutoOpen modules, if they the two being consolidated were only used in that fashion, then this will have no effect on users. And also this will have no effect on users only using Unquote for its unit testing features.
  3. Rename `Swensen.Unquote.Operators.Private` to `Swensen.Unquote.Operators.Internal` and mark it with the `System.Obsolete` so that it is hidden from Visual Studio IntelliSense (the EditorBrowsable attribute not being honored by F#, a recently filed bug: http://stackoverflow.com/questions/6527141/is-it-possible-to-mark-a-module-function-as-hidden-from-intellisense-discovery/6527933#6527933). This shouldn't effect any users as the module was never intended to be used publicly and is only public because due to references by other legitimately public inlined operators.  

Original issue reported on code.google.com by stephen....@gmail.com on 30 Jun 2011 at 3:21

@GoogleCodeExporter

This comment has been minimized.

Copy link
Author

commented Jun 21, 2015

One more breaking change: moved test, raises and other assertion operators in 
their own module, Swensen.Unquote.Assertions for folks who only want to use 
Unquote for unit testing and not pollute their environment. opening 
Swensen.Unquote auto opens Assertions though, so not a big breaking change for 
most.

Original comment by stephen....@gmail.com on 7 Jul 2011 at 3:36

  • Added labels: Priority-Low
  • Removed labels: Priority-Medium
@GoogleCodeExporter

This comment has been minimized.

Copy link
Author

commented Jun 21, 2015

Original comment by stephen....@gmail.com on 7 Jul 2011 at 3:36

  • Changed state: Fixed
@GoogleCodeExporter

This comment has been minimized.

Copy link
Author

commented Jun 21, 2015

Original comment by stephen....@gmail.com on 7 Jul 2011 at 3:39

  • Added labels: Milestone-Release2.0.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.