Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Activity
  • May 14 01:33
    poulson closed #276
  • May 14 01:33
    poulson commented #276
  • May 14 01:30

    poulson on master

    Update README.md (compare)

  • May 14 01:24

    poulson on master

    added logo (compare)

  • May 10 21:37
    jedbrown commented #276
  • May 10 21:25
    poulson commented #276
  • May 10 21:21
    jedbrown commented #276
  • May 10 17:08
    poulson commented #276
  • May 10 17:03
    tesch1 opened #276
  • Apr 10 13:18
    JM1 commented #275
  • Apr 10 13:16
    JM1 synchronize #275
  • Apr 10 08:56
    JM1 opened #275
  • Mar 06 03:47
    Raviteja1996 closed #274
  • Mar 05 05:46
    Raviteja1996 opened #274
  • Feb 11 21:53
    BenBrock commented #228
  • Feb 11 21:52
    BenBrock commented #228
  • Feb 11 21:51
    poulson commented #228
  • Feb 11 21:50
    poulson commented #228
  • Feb 11 21:45
    BenBrock commented #228
  • Jan 23 23:57
    adambaskerville commented #273
Jack Poulson
@poulson
it is helpful as a reference but not as an introduction
Ryan H. Lewis
@rhl-
i guess I was just thinking about understanding what is missing
Jack Poulson
@poulson
what is missing is a complete rewrite
Ryan H. Lewis
@rhl-
well, a reference for the API's is super useful
Jack Poulson
@poulson
that's what the header files are
Ryan H. Lewis
@rhl-
and the stuff you have looks good
no, thats not the same
there are things like preconditions and post conditions
and the Latex statements of the equations you solve inform you what the headers do
why do you want a complete rewrite, for me, most of the content has been largely accurate
Jack Poulson
@poulson
huge amounts of things are completely undocumented
and huge amounts are out of date
there is virtually nothing there on the sparse functionality
there is nothing on the lattice reduction
there is nothing on the support for higher precision
Ryan H. Lewis
@rhl-
right, so, thats why documentation coverage is useful, right?
Jack Poulson
@poulson
there is nothing on the D&C SVD or EVD
there is nothing on the AED Hessenberg QR implementation
there is nothing on the number theory support
Ryan H. Lewis
@rhl-
right, so, you see what I am saying?
generating coverage is a good first step
so autogeneration could perhaps give us a sense of where we are missing stuff
Jack Poulson
@poulson
perhaps, but I do not consider autogenerated things to be documentation
it is more so scaffolding for documentation
Ryan H. Lewis
@rhl-
yeah, exactly
Jack Poulson
@poulson
but it doesn't suggest any path for the user to learn how to use the library
Ryan H. Lewis
@rhl-
yeah, that makes sense
its likely that more people would be interested in tutorials for the bindings
than tutorials for C++ code itself
Jack Poulson
@poulson
I am still horrified that I know people who have printed out the Elemental doc pdfs more than once
Ryan H. Lewis
@rhl-
wow...
anyways, its hard for me to know what to add without first seeing what is missing
it would also seem reasonable to move just the HEAD documentation into the Elemental repository, and copy versions of it out to the website repo as needed
Jack Poulson
@poulson
more important than what is missing is that a huge amount is out of date
I don't like the docs being in the main repo because it clutters the commit history
Ryan H. Lewis
@rhl-
(not to sound crass, but, that is what auto generation is for)
@poulson: not sure what you mean, the documentation is just as important as the code itself.
Jack Poulson
@poulson
perhaps, but it is useful to be able to filter
Ryan H. Lewis
@rhl-
if anything the documentation is more important :)
Jed Brown
@jedbrown
@poulson What do you mean by not wanting docs in the main repo? That sounds like asking for it to be even more out of date.
Ryan H. Lewis
@rhl-
@jedbrown +1
Jed Brown
@jedbrown
By having it in the main repo, the expectation is that docs are updated concurrently with changes to the library.
Ryan H. Lewis
@rhl-
@jedbrown +1
Jed Brown
@jedbrown
Or do you just mean that generated docs shouldn't be checked in?
Jack Poulson
@poulson
certainly the generated docs should not be
Ryan H. Lewis
@rhl-
yeah, no question about that
Jack Poulson
@poulson
Elemental's docs used to be in a doc/ subfolder back when GitHub pages required a separate branch
it caused huge pains
Ryan H. Lewis
@rhl-
i dont understand what github pages have to do with this
Jack Poulson
@poulson
it has been a while since the switch was made to a separate elemental-web page, which was more general and for the whole website