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

More well-defined export statement / user API #399

Merged
merged 8 commits into from
Sep 12, 2019
Merged

Conversation

glwagner
Copy link
Member

@glwagner glwagner commented Sep 12, 2019

This PR rewrites the top-level export statement for Oceananigans.jl. Mainly it omits many names from the export statement that we do not intend to be part of the user API.

Resolves #364.
Resolves #313.

src/Oceananigans.jl Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Sep 12, 2019

Codecov Report

Merging #399 into master will increase coverage by 0.1%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff            @@
##           master     #399     +/-   ##
=========================================
+ Coverage   71.69%   71.79%   +0.1%     
=========================================
  Files          23       23             
  Lines        1413     1411      -2     
=========================================
  Hits         1013     1013             
+ Misses        400      398      -2
Impacted Files Coverage Δ
...closures/rozema_anisotropic_minimum_dissipation.jl 23.95% <ø> (ø) ⬆️
src/Oceananigans.jl 100% <ø> (ø) ⬆️
src/turbulence_closures/TurbulenceClosures.jl 56.25% <ø> (ø) ⬆️
...ures/verstappen_anisotropic_minimum_dissipation.jl 52.54% <ø> (ø) ⬆️
src/output_writers.jl 77.71% <ø> (ø) ⬆️
src/poisson_solvers.jl 98.4% <ø> (+0.78%) ⬆️
src/fields.jl 62.82% <100%> (+0.79%) ⬆️
src/turbulence_closures/smagorinsky.jl 67.79% <100%> (ø) ⬆️
src/equation_of_state.jl 100% <100%> (ø) ⬆️

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 1b521b0...83f8daa. Read the comment docs.

@glwagner
Copy link
Member Author

@ali-ramadhan merge if you approve.

@ali-ramadhan ali-ramadhan merged commit ab61592 into master Sep 12, 2019
@ali-ramadhan ali-ramadhan deleted the better-exports branch September 12, 2019 22:53
arcavaliere pushed a commit to arcavaliere/Oceananigans.jl that referenced this pull request Nov 6, 2019
More well-defined export statement / user API

Former-commit-id: ab61592
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.

Too many exported names ardata and ardata_view
2 participants