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

Missing docs #180

Open
9 tasks
mofeing opened this issue Aug 9, 2024 · 0 comments
Open
9 tasks

Missing docs #180

mofeing opened this issue Aug 9, 2024 · 0 comments
Assignees
@HerManNav @arturgs @mofeing @jofrevalles @starsfordummies @Todorbsc
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone
0.8

Comments

@mofeing
Copy link
Member

mofeing commented Aug 9, 2024 •
edited
Loading

We have changed maaaany things in the last releases and haven't documented yet. As @starsfordummies correctly pointed, this makes very hard for new users to start using Tenet.

  • Create a section titled "API reference" with all the docstrings @jofrevalles
    • I believe there is a Documenter.jl command for that
  • Create a section titled "Developer reference" with info about how Tenet works internally
    • TensorNetwork's internal structure
    • Abstract types and inheritance
      • Keyword dispatch
    •  Traits
    • CachedField
    • IndexCounter
  • Update old sections with a better explanation
@mofeing mofeing added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Aug 9, 2024
@mofeing mofeing added the good first issue Good for newcomers label Aug 9, 2024
@mofeing mofeing pinned this issue Aug 9, 2024
@mofeing mofeing added this to the 0.8 milestone Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@HerManNav HerManNav

@arturgs arturgs

@mofeing mofeing

@jofrevalles jofrevalles

@starsfordummies starsfordummies

@Todorbsc Todorbsc

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
0.8
Development

No branches or pull requests
6 participants
@HerManNav @arturgs @mofeing @jofrevalles @starsfordummies @Todorbsc