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

Various chores #213

Merged
merged 7 commits into from
Apr 21, 2024
Merged

Various chores #213

merged 7 commits into from
Apr 21, 2024

Conversation

YeungOnion
Copy link
Contributor

@YeungOnion YeungOnion commented Apr 12, 2024

A few sets of chore commits

  • a set of edits to documentation concerning intro to crate, usage, and contrib
  • update Cargo.toml to point at correct repo not explicit docs, since all on docs.rs
  • update examples, update syntax and link to docs.rs
  • first response to this PSA on Rust user forum

@FreezyLemon
Copy link
Contributor

Can I suggest disabling the macros feature in nalgebra?

nalgebra = { version = "0.29", default-features = false, features = ["std", "rand"] }

# or:

[dependencies.nalgebra]
version = "0.29"
default-features = false
features = ["std", "rand"]

It looks like it is unnecessary for statrs and reduces the amount of dependencies & compile time a bit

@YeungOnion
Copy link
Contributor Author

Considering making all multivariate nalgebra dependencies a feature so it can be opted out of, and I think #209 will only use the macros in tests.

This PR is already non-specific, but mostly related to docs, but the idea is great; I'll call out the mention in #209.

@FreezyLemon
Copy link
Contributor

Thanks! Another small thing, this one might be suited for this PR: The README uses CRLF line endings, which is a bit unexpected because all other files in the project seem to use LF only. Bit of a nitpick, but basically free to fix

rely on docs.rs to have correct versino in url for docs
@YeungOnion
Copy link
Contributor Author

reordered commits in hopes to seem a little more organized.
I also missed one of the math texts that was listed as ignore instead of text

@YeungOnion YeungOnion merged commit dc82d3c into master Apr 21, 2024
2 checks passed
@YeungOnion YeungOnion deleted the chores branch May 25, 2024 00:14
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.

2 participants