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

Small page/manual link fixes #221

Merged

Conversation

TymonKilich
Copy link
Contributor

@TymonKilich TymonKilich commented Mar 3, 2021

Hi, I've decided to try to do something useful as I was going through manual 😃

I fixed the links in the readme and at the index page of the manual (they didn't work). I also changed links from juliasymbolics.github.io/SymbolicUtils.jl to https://symbolicutils.juliasymbolics.org. Not sure whether it's the right way. I see the pages are in PkgPage.jl and it said to edit index.md directly.

I think it will be easier for first time contributors (such as me) if it was written what are the docs/pages built in. It says "Website built with Franklin.jl." at the bottom of the page, but I've found that PkgPage.jl is used only after looking at CI and gh-pages branch. So I added PkgPage.jl with link to "Website built with..." part in the footer.

@codecov-io
Copy link

Codecov Report

Merging #221 (9a3cb08) into master (b8945de) will decrease coverage by 0.10%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #221      +/-   ##
==========================================
- Coverage   86.10%   86.00%   -0.11%     
==========================================
  Files          12       12              
  Lines         993      993              
==========================================
- Hits          855      854       -1     
- Misses        138      139       +1     
Impacted Files Coverage Δ
src/matchers.jl 94.23% <0.00%> (-1.93%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b8945de...9a3cb08. Read the comment docs.

@TymonKilich
Copy link
Contributor Author

TymonKilich commented Mar 3, 2021

WIP: I've found some more breaks within the pages/manual due to associativity-commutativity (AC) rules being default now:

Please treat this PR as WIP.

@TymonKilich TymonKilich changed the title Small link fixes WIP: Small page/manual fixes Mar 3, 2021
@shashi
Copy link
Member

shashi commented Mar 3, 2021

Thanks, these are awesome fixes!

Those broken examples are a bit of a good problem :-p the simplifications happen automatically. But we should fix it! It's my bad for not keeping an eye on them.

@TymonKilich
Copy link
Contributor Author

TymonKilich commented Mar 3, 2021

I can try to fix the examples and come up with the new (hopefully adequate) ones if that's okay with you. :)

If yes should this be a part of this PR or should I create a new one and limit this one to just fixes of the links?

@shashi
Copy link
Member

shashi commented Mar 3, 2021

Of course, thank you!! In this PR is fine!

@MasonProtter
Copy link
Member

MasonProtter commented Mar 6, 2021

Maybe we should just merge this one in the meantime and open a new PR for the example so these problems get fixed ASAP.

Are the test failures real? I don't see how this could break DataDrivenDiffEq or ModelingToolkit. I'll just re-run the tests.

@TymonKilich
Copy link
Contributor Author

Sure, by all means merge as it is. Fixing manual takes a bit more time than I thought and I'll do it in separate PR.

I have no idea why the test fail. I didn't touch anything related to tests.

@TymonKilich TymonKilich changed the title WIP: Small page/manual fixes Small page/manual link fixes Mar 6, 2021
@TymonKilich
Copy link
Contributor Author

Maybe we should just merge this one in the meantime and open a new PR for the example so these problems get fixed ASAP.

I've almost fixed listed problems. I nearly finished Getting Started and Term Rewriting sections. Only two things left.
Can't really come up with good example for @acrule since now it simplifies by default and I'd like to have some nicer example for Composing rewriters.

I'll open a PR tomorrow (actually later today where I live). Haven't looked into Interfacing, Code generation and API Reference sections yet but they may be left for further PR if you prefer to fix examples ASAP.

@ChrisRackauckas
Copy link
Member

Those downstream issues were some versioning things we fixed over the last day.

@ChrisRackauckas ChrisRackauckas merged commit ce87b71 into JuliaSymbolics:master Mar 7, 2021
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.

5 participants