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

docs: Documentation Improvements #156

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Conversation

shikharvashistha
Copy link
Collaborator

This pull adds the following changes to our current documentation:

  1. Indexing Improvements
  2. Introduced C++ syntax highlighting
  3. Aggregated contributors list at the end
  4. Addition of basic tutorial
  5. Format Improvements

The preview of changes can be found here.

@github-actions
Copy link

github-actions bot commented Feb 7, 2022

This Pull request Passed all of clang-tidy tests. 👍

@amitsingh19975
Copy link
Collaborator

I loved the documentation, but there are some minor things that make it harder to read and reason about.

  1. Except for Tensor, every class' constructor, assignment, modifying functions, etc., are mixed.
  2. It is hard to find function names from convoluted prototypes. It would be better if we have separate columns with names, return types and prototypes.

@bassoy, what do you think of the second point?

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

Successfully merging this pull request may close these issues.

2 participants