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

Expose the Client::send method, adding a brief doccomment #40

Merged
merged 1 commit into from
Jun 2, 2020

Conversation

Alch-Emi
Copy link
Contributor

This was briefly discussed in the Matrix room, but I believe that exposing the Client::send at least until the 1.0 release may be beneficial, as the ruma api is extensive and fairly easy to use, thus greatly extending the functionality of this library until more wrapper methods are complete. The doccomment used for this method indicates that it is not recommended to use this method while a wrapper method exists for the same purpose, and warns that this method will not update client state.

@codecov-commenter
Copy link

Codecov Report

Merging #40 into master will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #40   +/-   ##
=======================================
  Coverage   75.39%   75.39%           
=======================================
  Files          23       23           
  Lines        4386     4386           
=======================================
  Hits         3307     3307           
  Misses       1079     1079           
Impacted Files Coverage Δ
matrix_sdk/src/client.rs 78.19% <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 1d9fccd...53876ea. Read the comment docs.

Copy link
Contributor

@poljar poljar left a comment

Choose a reason for hiding this comment

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

Could we get an example in the docs there. I think most people that won't look at the rust-sdk code will be a bit confused.

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.

3 participants