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

Adding more docstrings, high level interface improvements #18

Merged
merged 26 commits into from
May 24, 2024

Conversation

thomvet
Copy link
Collaborator

@thomvet thomvet commented Apr 24, 2024

This PR addresses the following:

  • adds a basic readme file
  • adds basic examples to documentation
  • further improves high level interface (everything starting with JUA...) - now approaching a usable state.
  • introduces many tests regarding the above interface.
  • increases flexibility in terms of what numerical types are usable directly in nodes; now also includes ComplexF32 and ComplexF64 and Strings (and arrays thereof).
  • introduced appropriate testing for the numerical types.
  • Complete server.jl docstrings
  • Complete highlevel_server.jl docstrings

Client side is still less documented, but I think this could now be merged.

Copy link

codecov bot commented Apr 24, 2024

Codecov Report

Attention: Patch coverage is 86.55462% with 48 lines in your changes are missing coverage. Please review.

Project coverage is 41.77%. Comparing base (04af27b) to head (a9b34b2).

Files Patch % Lines
src/highlevel_types.jl 83.97% 29 Missing ⚠️
src/highlevel_server.jl 85.10% 7 Missing ⚠️
src/client.jl 50.00% 4 Missing ⚠️
src/highlevel_client.jl 88.88% 4 Missing ⚠️
src/helper_functions.jl 91.30% 2 Missing ⚠️
src/types.jl 85.71% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #18      +/-   ##
==========================================
+ Coverage   38.45%   41.77%   +3.31%     
==========================================
  Files          10       12       +2     
  Lines        3573     3799     +226     
==========================================
+ Hits         1374     1587     +213     
- Misses       2199     2212      +13     

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

@thomvet thomvet self-assigned this Apr 24, 2024
@thomvet thomvet mentioned this pull request May 9, 2024
5 tasks
@thomvet thomvet changed the title Adding more docstrings [WIP] Adding more docstrings May 12, 2024
@thomvet thomvet changed the title [WIP] Adding more docstrings Adding more docstrings, high level interface improvements May 22, 2024
@thomvet
Copy link
Collaborator Author

thomvet commented May 22, 2024

@martinkosch: Can you have a look and approve/merge if you think it's fine?

@martinkosch martinkosch merged commit 0ad0171 into main May 24, 2024
6 checks passed
@thomvet thomvet deleted the docstrings branch May 24, 2024 20:28
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