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

Import StaticArrays.SVector into docs to have type-only printing #72

Merged
merged 1 commit into from
Jul 23, 2022

Conversation

jmert
Copy link
Owner

@jmert jmert commented Jul 23, 2022

This avoids a doctest failures from mismatched owner modules depending
on the version of StaticArrays which is loaded. For StaticArrays < v1.5,
the fully-qualified type is StaticArrays.SVector, but starting with
v1.5 the type definition moved to StaticArraysCore.SVector.

By importing explicitly from StaticArrays into the environment, the
printing system skips the module component and therefore we don't see
any discrepancy in printing no matter which version of
Julia + StaticArrays is being used.

This avoids a doctest failures from mismatched owner modules depending
on the version of StaticArrays which is loaded. For StaticArrays < v1.5,
the fully-qualified type is `StaticArrays.SVector`, but starting with
v1.5 the type definition moved to `StaticArraysCore.SVector`.

By importing explicitly from StaticArrays into the environment, the
printing system skips the module component and therefore we don't see
any discrepancy in printing no matter which version of
Julia + StaticArrays is being used.
@codecov
Copy link

codecov bot commented Jul 23, 2022

Codecov Report

Merging #72 (ec13978) into master (2b3e956) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #72   +/-   ##
=======================================
  Coverage   98.27%   98.27%           
=======================================
  Files          11       11           
  Lines         984      984           
=======================================
  Hits          967      967           
  Misses         17       17           
Impacted Files Coverage Δ
src/sphere.jl 100.00% <ø> (ø)

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 2b3e956...ec13978. Read the comment docs.

@jmert jmert merged commit 6f772d8 into master Jul 23, 2022
@jmert jmert deleted the jw/sa_docstrings branch July 23, 2022 18:09
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.

None yet

1 participant