Skip to content

Commit 1120f69

Browse files
committed
Fix README.md
1 parent ba986cd commit 1120f69

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
[![Build Status](https://travis-ci.org/JuliaString/ModuleInterfaceTools.jl.svg?branch=master)](https://travis-ci.org/JuliaString/ModuleInterfaceTools.jl)
44

5-
[![Coverage Status](https://coveralls.io/repos/github/JuliaString/ModuleInterfaceTools.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaString/ModuleInterfaceTools.jl?branch=master)
6-
5+
[![Coverage Status](https://coveralls.io/repos/github/JuliaString/ModuleInterfaceTools.jl/badge.svg
6+
?branch=master)](https://coveralls.io/github/JuliaString/ModuleInterfaceTools.jl?branch=master)
77
[![codecov.io](http://codecov.io/github/JuliaString/ModuleInterfaceTools.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaString/ModuleInterfaceTools.jl?branch=master)
88

99
The `ModuleInterfaceTools` package is now working on both the release version (v0.6.2) and the latest master (v0.7.0-DEV).
@@ -17,25 +17,26 @@ This is a bit of a work-in-progress, I heartily welcome any suggestions for bett
1717
```julia
1818
@api <cmd> [<symbols>...]
1919

20-
* @api init # set up module/package for adding names
21-
* @api freeze # use at end of module, to "freeze" API
20+
* @api list # display information about this module's API
21+
* @api freeze # use at end of module, to "freeze" API
2222

23+
* @api list <modules>... # display information about one or more modules' API
2324
* @api use <modules>... # for normal use, i.e. `using`
2425
* @api test <modules>... # using public and develop symbols, for testing purposes
2526
* @api extend <modules>... # for development, imports `base`, `public`, and `develop` lists,
2627
* # uses `define_public`and `define_develop` lists
2728
* @api export <modules>... # export api symbols
2829

29-
* @api base <names...> # Add functions from Base that are part of the API
30-
* @api public <names...> # Add functions that are part of the public API
31-
* @api develop <names...> # Add functions that are part of the development API
32-
* @api define_public <names...> # Add other symbols that are part of the public API (structs, consts)
33-
* @api define_develop <names...> # Add other symbols that are part of the development API
34-
* @api define_module <names...> # Add submodule names that are part of the API
35-
* @api maybe_public <names...> # Conditionally import functions from Base, or define them
30+
* @api base <names...> # Add functions from Base that are part of the API
31+
* @api public! <names...> # Add functions that are part of the public API
32+
* @api develop! <names...> # Add functions that are part of the development API
33+
* @api public <names...> # Add other symbols that are part of the public API (structs, consts)
34+
* @api develop <names...> # Add other symbols that are part of the development API
35+
* @api modules <names...> # Add submodule names that are part of the API
36+
* @api base! <names...> # Conditionally import functions from Base, or define them
3637
```
3738

38-
This also includes the `@def` macro, which I've found very useful!
39+
This also includes the `@def` macro, renamed as `@api def` which I've found very useful!
3940

4041
I would also like to add commands that add the functionality of `@reexport`,
4142
but instead of exporting the symbols found in the module(s), add them to either the public
@@ -45,4 +46,3 @@ have a docstring, and are not exported, to the develop list, and all exported na
4546
Another thing I'd like to add is a way of using/importing a module, but having pairs of names, for renaming purposes, i.e. something like `@api use Foobar: icantreadthisname => i_cant_read_this_name`
4647
which would import the variable from Foobar, but with the name after the `=>`.
4748

48-
Finally, I'd like to add a few interactive commands, such as `@api list public`, or `@api list develop Foobar`, to display what the API is of the current module, or of the given module(s).

0 commit comments

Comments
 (0)