Giter Club home page Giter Club logo

Comments (14)

kalmarek avatar kalmarek commented on June 3, 2024

I don't think I've touched docs/src/perm.md. I will try to update it in the comming weeks (new semester, less teaching)

from abstractalgebra.jl.

wbhart avatar wbhart commented on June 3, 2024

from abstractalgebra.jl.

kalmarek avatar kalmarek commented on June 3, 2024

Can I/should I use doctests? @refs?

from abstractalgebra.jl.

wbhart avatar wbhart commented on June 3, 2024

from abstractalgebra.jl.

kalmarek avatar kalmarek commented on June 3, 2024

Well, I have to admit, Documenter is increadibly slow, and fragile as hell.
I've already spent more time tracking spaces, which throw it off-balance, than writing the actual text... ;/

from abstractalgebra.jl.

kalmarek avatar kalmarek commented on June 3, 2024

please have a look at https://github.com/kalmarek/AbstractAlgebra.jl/tree/enh/perm_docs

I have troubles with Documenter not finding ::PermGroup. Any ideas?

For now only perms and PermGroups are documented, YoungTabs will have to wait longer...

from abstractalgebra.jl.

wbhart avatar wbhart commented on June 3, 2024

from abstractalgebra.jl.

kalmarek avatar kalmarek commented on June 3, 2024

thanks for the extensive list of corrections! I will look into them today or tomorrow

from abstractalgebra.jl.

kalmarek avatar kalmarek commented on June 3, 2024
  • removed "list"

  • added plural

  • the table was a leftover, I deleted it;

  • lower-cased all You(r), always forget that these are not capitalized in English

  • corrected various typos

  • setpermstyle doc displays correctly locally

  • added the and (inner) to "call to perm constructor" (but this occurred only once?)

  • Generic.perm and Generic.PermGroup are documented as types, not functions; constructors of perm and methods of are documented by hand

  • ad Warning: I added a modified field to perm which invalidates cycle decomposition.

  • ad "Note: be careful..." fixed by the modified bit;

I added jldoctests in the Examples sections in docstring for comparison and misc. I'm be fine with this as it is, but do You think more prose in those section is needed?

from abstractalgebra.jl.

wbhart avatar wbhart commented on June 3, 2024

Looks good. Do you want to make a pull request and I'll merge it.

from abstractalgebra.jl.

kalmarek avatar kalmarek commented on June 3, 2024

I'm in the middle of writing docs for YoungTabs, I will make a pull request once I'm finished, ok?
(not sure if this will happen over the weekend though)

from abstractalgebra.jl.

wbhart avatar wbhart commented on June 3, 2024

Of course, no problem.

from abstractalgebra.jl.

kalmarek avatar kalmarek commented on June 3, 2024

I had to reconsider, more changes are piling up for Young tabelaux

from abstractalgebra.jl.

kalmarek avatar kalmarek commented on June 3, 2024

closed by #128

from abstractalgebra.jl.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.