You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by xu...@apache.org on 2023/12/28 06:55:58 UTC
(incubator-opendal) branch main updated: docs: Address branding for haskell and C bindings (#3840)
This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 23cb8e6fa docs: Address branding for haskell and C bindings (#3840)
23cb8e6fa is described below
commit 23cb8e6fa94213af27d5c432ab476d4bb3499f5f
Author: Xuanwo <gi...@xuanwo.io>
AuthorDate: Thu Dec 28 14:55:53 2023 +0800
docs: Address branding for haskell and C bindings (#3840)
* docs: Address branding for haskell and C bindings
Signed-off-by: Xuanwo <gi...@xuanwo.io>
* Add core
Signed-off-by: Xuanwo <gi...@xuanwo.io>
* Polish
Signed-off-by: Xuanwo <gi...@xuanwo.io>
---------
Signed-off-by: Xuanwo <gi...@xuanwo.io>
---
bindings/c/src/lib.rs | 2 +-
bindings/haskell/haskell-src/OpenDAL.hs | 8 ++++----
core/src/lib.rs | 3 ++-
3 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/bindings/c/src/lib.rs b/bindings/c/src/lib.rs
index a4429813b..cfd46f92e 100644
--- a/bindings/c/src/lib.rs
+++ b/bindings/c/src/lib.rs
@@ -23,7 +23,7 @@
// Nearly all the functions exposed to C FFI are unsafe.
#![allow(clippy::missing_safety_doc)]
-//! The OpenDAL C binding.
+//! The Apache OpenDAL C binding.
//!
//! The OpenDAL C binding allows users to utilize the OpenDAL's amazing storage accessing capability
//! in the C programming language.
diff --git a/bindings/haskell/haskell-src/OpenDAL.hs b/bindings/haskell/haskell-src/OpenDAL.hs
index 1931e037c..8d869a85d 100644
--- a/bindings/haskell/haskell-src/OpenDAL.hs
+++ b/bindings/haskell/haskell-src/OpenDAL.hs
@@ -17,14 +17,14 @@
-- |
-- Module : OpenDAL
--- Description : Haskell bindings for OpenDAL
--- Copyright : (c) 2023 OpenDAL
+-- Description : Haskell bindings for Apache OpenDAL
+-- Copyright : (c) 2023 Apache OpenDAL
-- License : Apache-2.0
-- Maintainer : OpenDAL Contributors <de...@opendal.apache.org>"
-- Stability : experimental
-- Portability : non - portable (GHC extensions)
--
--- This module provides Haskell bindings for OpenDAL.
+-- This module provides Haskell bindings for Apache OpenDAL.
module OpenDAL
( -- * Operator APIs
@@ -557,4 +557,4 @@ nextLister (Lister lister) = withForeignPtr lister $ \listerptr ->
else do
let code = parseErrorCode $ fromIntegral $ ffiCode ffiResult
errMsg <- peekCString (errorMessage ffiResult)
- return $ Left $ OpenDALError code errMsg
\ No newline at end of file
+ return $ Left $ OpenDALError code errMsg
diff --git a/core/src/lib.rs b/core/src/lib.rs
index 01a57a183..50eadc466 100644
--- a/core/src/lib.rs
+++ b/core/src/lib.rs
@@ -17,7 +17,8 @@
#![cfg_attr(docs, feature(doc_auto_cfg))]
-//! OpenDAL is the Open Data Access Layer to **freely** access data.
+//! Apache OpenDAL™ is a data access layer that allows users to easily and
+//! efficiently retrieve data from various storage services in a unified way.
//!
//! - Documentation: All docs are carried by self, visit [`docs`] for more.
//! - Services: All supported services could be found at [`services`].