Merge pull request #63 from SpringQL/docs/clickable-link

docs: make links in comments clickable
SpringQL · Jul 12, 2022 · 97bcf59 · 97bcf59
2 parents 5704f1b + 75b569d
commit 97bcf59
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/springql.h b/springql.h
@@ -80,7 +80,7 @@ struct SpringConfig *spring_config_default(void);
  * # Parameters
  *
  * - `overwrite_config_toml`: TOML format configuration to overwrite default.
- *   See https://springql.github.io/deployment/configuration for TOML format and configuration values.
+ *   See <https://springql.github.io/deployment/configuration> for TOML format and configuration values.
  *
  * # Panics
  *
@@ -145,7 +145,7 @@ enum SpringErrno spring_command(const struct SpringPipeline *pipeline, const cha
  *
  * Do not call this function from threads.
  * If you need to pop from multiple in-memory queues using threads, use `spring_pop_non_blocking()`.
- * See: https://github.com/SpringQL/SpringQL/issues/125
+ * See: <https://github.com/SpringQL/SpringQL/issues/125>
  *
  * # Returns
  *

diff --git a/src/lib.rs b/src/lib.rs
@@ -56,7 +56,7 @@ pub extern "C" fn spring_config_default() -> *mut SpringConfig {
 /// # Parameters
 ///
 /// - `overwrite_config_toml`: TOML format configuration to overwrite default.
-///   See https://springql.github.io/deployment/configuration for TOML format and configuration values.
+///   See <https://springql.github.io/deployment/configuration> for TOML format and configuration values.
 ///
 /// # Panics
 ///
@@ -157,7 +157,7 @@ pub unsafe extern "C" fn spring_command(
 ///
 /// Do not call this function from threads.
 /// If you need to pop from multiple in-memory queues using threads, use `spring_pop_non_blocking()`.
-/// See: https://github.com/SpringQL/SpringQL/issues/125
+/// See: <https://github.com/SpringQL/SpringQL/issues/125>
 ///
 /// # Returns
 ///