Skip to content

Commit

Permalink
docs: Address branding for haskell and C bindings (apache#3840)
Browse files Browse the repository at this point in the history
* docs: Address branding for haskell and C bindings

Signed-off-by: Xuanwo <[email protected]>

* Add core

Signed-off-by: Xuanwo <[email protected]>

* Polish

Signed-off-by: Xuanwo <[email protected]>

---------

Signed-off-by: Xuanwo <[email protected]>
  • Loading branch information
Xuanwo authored Dec 28, 2023
1 parent 90d8d51 commit 23cb8e6
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion bindings/c/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions bindings/haskell/haskell-src/OpenDAL.hs
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>"
-- 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

Expand Down Expand Up @@ -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
return $ Left $ OpenDALError code errMsg
3 changes: 2 additions & 1 deletion core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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`].
Expand Down

0 comments on commit 23cb8e6

Please sign in to comment.