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

Update docs generations #1846

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sfc-gh-jvasquezrojas
Copy link
Collaborator

@sfc-gh-jvasquezrojas sfc-gh-jvasquezrojas commented Nov 11, 2024

Pre-review checklist

  • N/A I've confirmed that instructions included in README.md are still correct after my changes in the codebase.
  • I've added or updated automated unit tests to verify correctness of my new code.
  • N/A I've added or updated integration tests to verify correctness of my new code.
  • I've confirmed that my changes are working by executing CLI's commands manually on MacOS.
  • I've confirmed that my changes are working by executing CLI's commands manually on Windows.
  • N/A I've confirmed that my changes are up-to-date with the target branch.
  • N/A I've described my changes in the release notes.
  • I've described my changes in the section below.

Changes description

Update docs generation to generate v20 model

Example output:
image

definition_entities_application.txt
definition_entities_function.txt

@sfc-gh-jvasquezrojas sfc-gh-jvasquezrojas requested a review from a team as a code owner November 11, 2024 02:18
Copy link
Contributor

@sfc-gh-jsikorski sfc-gh-jsikorski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems ok. Notified @sfc-gh-mheavin about this PR - i think we need his opinion on this.

).exists():
errors.append(f"Section `{property_name}` was not properly generated")

assert len(errors) == 0, "\n".join(errors)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add more assertions/test cases to check if proper number of files is generated and their content is ok?

Copy link
Contributor

@sfc-gh-mheavin sfc-gh-mheavin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Can we specify the type of code-block [ .. code-block:: json or .. code-block:: yaml ]
  • Please add a blank line after the ==== lines before sentences (e.g. The following table...)
  • Add periods at the end of the description sentences or fragments
  • It shows the schema version as 1.
  • Can we get more descriptive descriptions? For example, the type description just says Type.
  • For enum values, can we include the enums, especially if the list is relatively short and known. For example, the type of entity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants