Skip to content

Add a bit about the API's skeleton to the API proposal template #63

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

Merged
merged 1 commit into from
Apr 2, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/propose_design.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,24 @@ Why are we doing this? What problems does it solve?
Introduce and explain the new APIs and concepts. How will this proposal be
implemented? Provide representative and edge-case examples.

Provide a skeleton of the proposed API by writing out types (don't need their
members or full implementation) as well as function and method signatures
(again, just the signature, don't need the function body):

```rust
pub struct Whatever { ... }

impl Whatever {
pub fn new(raw: &web_sys::RawWhatever) -> Self { ... }
pub fn another(&self) -> Another { ... }
}

pub struct Another { ... }

// Does X, Y, and Z when dropped.
impl Drop for Another {}
```

## Drawbacks, Rationale, and Alternatives

Does this design have drawbacks? Are there alternative approaches? Why is this
Expand Down