Skip to content

Documentation not generated for functions #1891

@johngmyers

Description

@johngmyers

Bug Report

Please answer these questions before submitting your issue. Thanks!

1. Minimal reproduce step (Required)

  1. Create a module which includes a package with the following main.k:
"""
This module provides utility functions for working with AWS tags.
"""

to_aws_tags = lambda tags: {str:str} -> [{str:str}] {
    """
    Converts a dictionary of tags to a list of AWS tags.

    :param tags: A dictionary of tags.
    :return: A list of AWS tags.
    """
    [{"key": key, "value": tags[key]} for key in sorted(list(tags))]
}
  1. Run kcl doc generate on the module.

2. What did you expect to see? (Required)

Documentation for the function placed in the output docs directory.

3. What did you see instead (Required)

No documentation files generated for the package.

4. What is your KCL components version? (Required)

0.11.1-darwin-arm64

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requesttoolIssues or PRs related to kcl tools inlucding format, lint, validation, document tools, etc.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions