Skip to content

Preview documentation doesn't render multiline Returns values correctly #2119

Description

@adam-fowler

Describe the bug
Preview documentation doesn't render multiline Returns values correctly while actual docc catalogs render them correctly.

To Reproduce
The following function when rendered in preview documentation places the two lines after the Returns in the Discussion section of the documentation. They should be part of the Return Value section

    /// Determines whether a field exists in a hash.
    ///
    /// - Documentation: [HEXISTS](https://valkey.io/commands/hexists)
    /// - Available: 2.0.0
    /// - Complexity: O(1)
    /// - Returns: One of the following
    ///     * 0: The hash does not contain the field, or key does not exist.
    ///     * 1: The hash contains the field.
    @inlinable
    public func hexists<Field: RESPStringRenderable>(_ key: ValkeyKey, field: Field) async throws(ValkeyClientError) -> Int {
        try await execute(HEXISTS(key, field: field))
    }

Environment

  • OS: macOS 15.7.3
  • Swift version: Apple Swift version 6.2.3 (swiftlang-6.2.3.3.21 clang-1700.6.3.2)
  • Visual Studio Code version: 1.109.5 (Universal)
  • vscode-swift version: 2.16.1

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Status
    Next

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions