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

bug: scarb doc markdown parsing #1795

Open
enitrat opened this issue Dec 1, 2024 · 1 comment
Open

bug: scarb doc markdown parsing #1795

enitrat opened this issue Dec 1, 2024 · 1 comment
Labels
bug Something isn't working
Milestone

Comments

@enitrat
Copy link
Contributor

enitrat commented Dec 1, 2024

Problem

Scarb doc is not parsing markdown correctly, see image:

https://docs.swmansion.com/scarb/corelib/core-boolean.html
image

see associated module doc: https://github.com/starkware-libs/cairo/blob/17a7e9bd171bb933e1641c7af0bc1d0767d4bc84/corelib/src/boolean.cairo#L1-L29

//! Boolean operations.
//!
//! The `bool` type is a primitive type in Cairo representing a boolean value that can be either
//! `true` or `false`. This module provides trait implementations for boolean operations.
//!
//! # Examples
//!
//! Basic boolean operations:
//!
//! ```
//!
//! let value = true;
//! assert!(value == true);
//! assert!(!value == false);
//! ```
//!
//! Converting to optional values with [`BoolTrait::then_some`]:
//!
//! ```
//! use core::boolean::BoolTrait;
//!
//! let bool_value = true;
//! let result = bool_value.then_some(42_u8);
//! assert!(result == Option::Some(42));
//!
//! let bool_value = false;
//! let result = bool_value.then_some(42_u8);
//! assert!(result == Option::None);
//! ```

Steps

No response

Possible Solution(s)

No response

Notes

No response

Version

No response

@enitrat enitrat added the bug Something isn't working label Dec 1, 2024
@github-project-automation github-project-automation bot moved this to Triage in Scarb Dec 1, 2024
@maciektr maciektr added this to the Scarb Doc milestone Dec 16, 2024
@maciektr
Copy link
Contributor

Note: make sure newlines are handled correctly as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Triage
Development

No branches or pull requests

2 participants