Skip to content

Commit

Permalink
Merge pull request #1 from JuliaPluto/define-public-api
Browse files Browse the repository at this point in the history
  • Loading branch information
@fonsp
fonsp authored Jan 16, 2024
2 parents f471e1a + 9dc80ef commit 5290ff7
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,50 @@ julia> order.runnable
SimpleCell("x + y")
```

# Public API

The public API is:

```
AbstractCell
NotebookTopology
ExprAnalysisCache
all_cells
updated_topology
exclude_roots
is_disabled
is_resolved
set_unresolved
is_soft_edge
topological_order
TopologicalOrder
cell_precedence_heuristic
DEFAULT_PRECEDENCE_HEURISTIC
where_assigned
where_referenced
ReactivityError
CyclicReferenceError
MultipleDefinitionsError
ImmutableDefaultDict
ImmutableSet
ImmutableVector
setdiffkeys
delete_unsafe!
ExpressionExplorerExtras
ExpressionExplorerExtras.can_be_function_wrapped
ExpressionExplorerExtras.can_macroexpand
ExpressionExplorerExtras.can_macroexpand_no_bind
ExpressionExplorerExtras.collect_implicit_usings
ExpressionExplorerExtras.maybe_macroexpand_pluto
ExpressionExplorerExtras.pretransform_pluto
```

# Contributing and testing

To work on this package, clone both the Pluto.jl and PlutoDependencyExplorer.jl repositories to your local drive. Then:
Expand Down

2 comments on commit 5290ff7

@fonsp
Copy link
Member Author

@fonsp fonsp commented on 5290ff7 Jan 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/98970

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.0.0 -m "<description of version>" 5290ff7e13ddb39c941fd60dfa78d46a417aa923
git push origin v1.0.0

Please sign in to comment.