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

Properlly deliniate our public API #10

Open
GarkGarcia opened this issue Jan 31, 2021 · 1 comment
Open

Properlly deliniate our public API #10

GarkGarcia opened this issue Jan 31, 2021 · 1 comment
Labels
help wanted Extra attention is needed meta

Comments

@GarkGarcia
Copy link
Contributor

We should decide what's going to be part of our public API before releasing. Things that aren't in the public API should be marked with a _ at the start of their names.

As a start, I propose to keep everything other than replace_*_with_*, named_characters, esc_aliases, generate.rl_inputrc and whatever is used by Mathics core outside of the public API. @rocky @mmatera Thoughts?

@GarkGarcia GarkGarcia added help wanted Extra attention is needed meta labels Jan 31, 2021
@GarkGarcia
Copy link
Contributor Author

Ok, I've realised marking everything with a _ will probably take some time, so here's an alternative solution: I've been writing lot's of documentation both in #11 and in #8 and I plan to merge all of it in a Sphix document. We could then include documentation for functions/classes we consider to be part of our public API in there and leave the rest of the library out of there. That way users aren't told about the existence of things they shouldn't use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed meta
Projects
None yet
Development

No branches or pull requests

1 participant