documentation and consistency change #558

Merged
merged 1 commit into from Sep 21, 2016

Conversation

Projects
None yet
1 participant
@ivg
Member

ivg commented Sep 21, 2016

Note: this change contains breaking changes, see below for more
information.

This PR introduces three main features:

  • new tool for rendering documentation;
  • the actual documentation as docstring;
  • interface changes to enforce consistency (breaking).

Interface Changes (breaking)

The interface changes are simple, previously we used to have functor
Foo that produces modules of type Foo, e.g., Printable(..) -> Printable.

Now, if there is a functor that produces modules of some
type, then we put it into enclosing module Foo that contains the
functor Make that produces modules of type S. For example,
Regular.Make(...) -> Regular.S, Trie.Make(...) -> Trie.S, etc.
So if you have an error message, that there is no module type Foo,
then it means, that you need to use Foo.S. If you have an error
message, stating that there is no functor Foo, then you need to use
Foo.Make.

documentation and consistency change
Note: this change contains breaking changes, see below for more
information.

This PR introduces three main features:

- new tool for rendering documentation;
- the actual documentation as docstring;
- interface changes to enforce consistency (breaking).

Interface Changes (breaking)
----------------------------

The interface changes are simple, previously we used to have functor
`Foo` that produces modules of type `Foo`, e.g., `Printable(..) ->
Printable`. Now, if there is a functor that produces modules of some
type, then we put it into enclosing module `Foo` that contains the
functor `Make` that produces modules of type `S`. For example,
`Regular.Make(...) -> Regular.S`, `Trie.Make(...) -> Trie.S`, etc.
So if you have an error message, that there is no module type `Foo`,
then it means, that you need to use `Foo.S`. If you have an error
message, stating that there is no _functor_ `Foo`, then you need to use
`Foo.Make`.

@ivg ivg merged commit cadb9b4 into BinaryAnalysisPlatform:master Sep 21, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@ivg ivg referenced this pull request Sep 21, 2016

Closed

Publish BAP Public API #518

@ivg ivg deleted the ivg:bap-doc-PR branch Oct 4, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment