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

Refactor docs #65

Merged
merged 33 commits into from
Oct 14, 2021
Merged

Refactor docs #65

merged 33 commits into from
Oct 14, 2021

Conversation

mkborregaard
Copy link
Member

Richard, could you take a look at whether you are OK with me taking the docs this way? Maybe we could just merge all these tomorrow, then you can judge by looking at the docs -they this is of course in principle WIP.
I'd like to move forward with this in preparation of the course.

Copy link
Member

@richardreeve richardreeve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me - I'm happy to have structure to the docs! I just wasn't sure about one issue with the routes section.

Comment on lines +10 to +13
distance
distances
heighttoroot
heightstoroot
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are definitely queries (above), but are they routes?

Suggested change
distance
distances
heighttoroot
heightstoroot

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess not really, maybe we should move them - I have them here because they are defined in routes.jl though.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I suggest in #63 that you move them from routes.jl to metrics.jl now that metrics.jl exists, so I think removing them from routes.md makes sense too.

@mkborregaard mkborregaard force-pushed the mkb/refactor_docs branch 2 times, most recently from eebede1 to 7190c6e Compare October 13, 2021 19:21
@mkborregaard
Copy link
Member Author

I've kept all of your text except the bit where you say that the only thing this package really cares about is Diversity.jl

@richardreeve
Copy link
Member

Again, the errors seem to be from the grandparent, so apart from the routes.md issue above I think this is good to merge too.

mkborregaard and others added 11 commits October 14, 2021 00:39
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
mkborregaard and others added 10 commits October 14, 2021 00:40
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
mkborregaard and others added 11 commits October 14, 2021 00:40
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
Co-authored-by: Richard Reeve <git@richardreeve.net>
@richardreeve
Copy link
Member

@mkborregaard So, do you want to just delete those routes-that-aren't routes and merge this to reduce the complexity of the PR chain?

@mkborregaard
Copy link
Member Author

Yeah I've actually done everything you asked but something seems to have gone wrong during the rebases. However the final version works, so let me just merge.

@mkborregaard mkborregaard changed the base branch from mkb/plotting_docs to dev October 14, 2021 13:16
@mkborregaard mkborregaard merged commit 1785864 into dev Oct 14, 2021
@coveralls
Copy link

coveralls commented Oct 14, 2021

Pull Request Test Coverage Report for Build 1341950236

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+2.003%) to 58.81%

Totals Coverage Status
Change from base Build 1341944170: 2.003%
Covered Lines: 1275
Relevant Lines: 2168

💛 - Coveralls

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

Successfully merging this pull request may close these issues.

3 participants