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

add just a few docs (issue #61) #62

Merged
merged 1 commit into from
May 14, 2023
Merged

add just a few docs (issue #61) #62

merged 1 commit into from
May 14, 2023

Conversation

droundy
Copy link
Contributor

@droundy droundy commented May 5, 2023

I'm figuring I'll probably add more as I work through this, and could either keep updating this PR or add more, depending on whether you'd prefer to merge more smaller PR or a larger one later.

@loyd loyd merged commit 1c6865c into loyd:master May 14, 2023
@loyd
Copy link
Owner

loyd commented May 14, 2023

Thanks for MR

@loyd
Copy link
Owner

loyd commented May 14, 2023

JFYI:

warning: unknown attribute `norun`. Did you mean `no_run`?
  --> /home/workspace/fave/clickhouse.rs/src/query.rs:48:5
   |
48 | /     /// Executes the query, returning a [`RowCursor`] to obtain results.
49 | |     ///
50 | |     /// # Example
51 | |     /// ```norun
...  |
64 | |     /// }
65 | |     /// ```
   | |___________^
   |
   = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
   = note: `#[warn(rustdoc::invalid_codeblock_attributes)]` on by default

Also it doesn't compile.

Fixed in master

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

2 participants