Skip to content

Improve code documentation #57

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 23, 2025
Merged

Improve code documentation #57

merged 1 commit into from
Jul 23, 2025

Conversation

@DongyuZhao
Copy link
Owner

@DongyuZhao DongyuZhao commented Jul 23, 2025

Summary

  • document parsing results and parser behavior
  • document AST constructor and error type
  • document Markdown language, inline parser and nodes
  • mention new docs in MARKDOWN_PARSER guide

Testing

  • swift test

https://chatgpt.com/codex/tasks/task_e_687fc3467dcc8322b2fb10de28883dd8

@DongyuZhao DongyuZhao merged commit de96d78 into user/donz/remove Jul 23, 2025
DongyuZhao added a commit that referenced this pull request Jul 23, 2025
@DongyuZhao
Remove outdated interfaces and classes (#59)
090c8e8 
* Remove outdated interfaces and classes

* Add documentation comments and update guide (#57)

* Add MarkdownEOFBuilder and simplify EOF handling (#58)
@DongyuZhao DongyuZhao deleted the codex/add-comments-and-documentation-to-code branch August 7, 2025 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

codex

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@DongyuZhao