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.

Sign up for GitHub

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

Jump to bottom

Public API #73

Open
GunnarFarneback opened this issue Oct 23, 2022 · 0 comments
Open

Public API #73

GunnarFarneback opened this issue Oct 23, 2022 · 0 comments

Comments

@GunnarFarneback
Copy link
Collaborator

RegistryTools exports one type and three functions:

  • RegBranch
  • register
  • check_and_update_registry_files
  • find_registered_version

There are seven packages in General depending on RegistryTools.
Ignoring the exported symbols, they also make use of the following:

  • BinaryBuilder: RegistryCache, registrator_errors.
  • LocalPackageServer: gitcmd.
  • LocalRegistry: gitcmd, RegistryData, write_registry, ReturnStatus, haserror, Compress.load.
  • PkgDev: -
  • Registrator: RegisterParams.
  • RegistryCI: package_relpath, get_stdlib_name, stdlibs, Compress.compress, Compress.load.
  • RetroCap:Compress.load, Compress.save.

Would it seem reasonable to simply define the public API as the union of the listed symbols and add docstrings to the ones which don't have one?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@GunnarFarneback