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

Reformat README and update development instructions #115

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JamesWrigley
Copy link
Collaborator

All content is the same, except for the new section about how to use development versions on Julia 1.11+.

Fixes #113.

All content is the same, except for the new section about how to use development
versions on Julia 1.11+.
@JamesWrigley JamesWrigley added the documentation Improvements or additions to documentation label Dec 11, 2024
@JamesWrigley JamesWrigley self-assigned this Dec 11, 2024
Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.33%. Comparing base (9c5d73a) to head (eb6f6b4).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #115   +/-   ##
=======================================
  Coverage   79.33%   79.33%           
=======================================
  Files          10       10           
  Lines        1916     1916           
=======================================
  Hits         1520     1520           
  Misses        396      396           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

more of an independent package. As such, to use a different version it's enough
to just `dev` it explicitly:
```julia-repl
pkg> dev https://github.com/JuliaLang/Distributed.jl.git
Copy link
Member

Choose a reason for hiding this comment

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

Isn't it just dev Distributed.jl or is the issue that it is not registered in the registry?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yep, it's not registered:

(@v1.11) pkg> dev Distributed.jl
    Updating registry at `~/.julia/registries/General.toml`
ERROR: The following package names could not be resolved:
 * Distributed (8ba89e20-285c-5b6f-9357-94700520ee1b in manifest but not in project)

Can we register it?

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, would need to be something similar to JuliaRegistries/General#89713

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@ViralBShah
Copy link
Member

@vchuravy Since you reviewed this PR - can you approve when ready?

Would you prefer we require review for every PR? I feel comfortable for folks to merge small PRs more quickly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Instructions for using development version of the package in the README
3 participants