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

Added in-place documentation #13

Open
martinfrances107 opened this issue Oct 22, 2022 · 1 comment
Open

Added in-place documentation #13

martinfrances107 opened this issue Oct 22, 2022 · 1 comment
Milestone

Comments

@martinfrances107
Copy link
Owner

Identity key functions provide how to use examples
Review output of cargo doc ... look for any thing broken

key elements. Commonly used code.

  1. Orthographic projection example.
  2. clipping,
  3. precision
  4. rotating,
  5. scaling translating

examples like this

/// Returns a person with the name given them
///
/// # Arguments
///
/// * name - A string slice that holds the name of the person
///
/// # Examples
///
/// /// // You can have rust code between fences inside the comments /// // If you pass --test to `rustdoc`, it will even test it for you! /// use doc::Person; /// let person = Person::new("name"); ///

@martinfrances107 martinfrances107 added this to the Alpha Release milestone Oct 22, 2022
@martinfrances107
Copy link
Owner Author

Added examples to the landing page.

239f1f1ccde5054a7c870479b4396ce1515de6e7

Still todo

Locate all function call that involve angles in degrees and document that.
Add test to describe the Stream Pipeline and Endpoints.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant