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
Add Documentation #137
Add Documentation #137
Conversation
Looks like I already had a draft PR. What needs to be added before merge? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again, please feel free to participate :)
And wow you also added an error guideline, thanks so much!
Looks very good to start!
There is an one stuff I request you to change,
Because of end-of-line issue, GitHub Action failed on cargo fmt
Then, I'll merge this and make it accessible via https://gluesql.org/book
I'm considering to use https://github.com/marketplace/actions/mdbook-action to automate
@panarch thoughts on what to do about this check error? |
@KyGost It would be the issue of your editor. |
@panarch rustfmt worked this time but the tests failed because of the example code, have a look at the fail details. |
@KyGost Ok, I think I got it if.. you are using Windows. Can you try In newline_style = "Unix" Or... it might be related to the cargo version. |
The issue coming up when I check the error on the commit is:
|
The EOL issue is annoying too, I'll play around with some settings and try to fix that at some point. Looks like the main issue however is that one references glue differently externally to how it is referenced internally. How can I get the tester to ignore the examples? |
@KyGost ok, I can say what's going on in here.
For convenience, I enabled And tests should work both with features & without features. I included several Your examples require Style is up to you. |
@panarch ahhh okay, thank you very much. Something different seems to have failed now though...? :-( |
@KyGost 👍 fyi. https://doc.rust-lang.org/reference/attributes.html So, in #[cfg(feature = "sled-storage")]
use gluesql::{parse, Glue, Payload, SledStorage, Value}; use gluesql::{parse, Glue, Payload, SledStorage, Value}; It only excludes |
Oh I see, I need to use #[cfg(feature = "sled-storage")]
mod sled_multi_threaded {
...
} Thanks |
@panarch it should work now but now includes needless items in the book. How can we avoid this? Is there a way to add the rules to the file outside of the file? |
Looks like it failed again.... Was the strictness increased recently? |
Oh, I just tested and found that. I'm simply using the default setting of clippy, it looks like it is because of recent |
That make sense. We might solve this by editing Let me know you found something, I'll also try to figure out. |
- Move examples to examples - Add contributing - Add contributors - Add community
@panarch woohoo! Tests passed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@KyGost Awesome 👍 👍 👍
I'll merge and build & upload to https://gluesql.org/book soon!
About making this implicitly, let's do it in another pr.
Thanks!!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@KyGost Awesome 👍 👍 👍
I'll merge and build & upload to https://gluesql.org/book soon!
About making this implicitly, let's do it in another pr.
Thanks!!
WIP