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

Document public API surface area #1122

Open
bterlson opened this issue Oct 4, 2022 · 1 comment
Open

Document public API surface area #1122

bterlson opened this issue Oct 4, 2022 · 1 comment
Milestone
Backlog

Comments

@bterlson
Copy link
Member

bterlson commented Oct 4, 2022

The docs website should contain API documentation for every exported member of the core compiler and standard library. Most important (I believe) are:

  • The shape of the type graph (especially Types)
  • The exported members of the program interface
  • The program host object (since using FS directly is an anti-pattern)
@ghost ghost added the Needs Triage label Oct 4, 2022
@timotheeguerin timotheeguerin added this to the [2022] November milestone Oct 4, 2022
@timotheeguerin
Copy link
Member

est: 8

@markcowl markcowl modified the milestones: [2023] January, [2023] March Dec 5, 2022
@markcowl markcowl modified the milestones: [2023] March, [2023] April Jan 28, 2023
@markcowl markcowl modified the milestones: [2023] April, Backlog Mar 14, 2023
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
Backlog
Development

No branches or pull requests
3 participants
@bterlson @timotheeguerin @markcowl