8000 Document forms and reports, macros, and object properties in the library documentation by dominion525 · Pull Request #116 · dominion525/jetdb · GitHub
[go: up one dir, main page]
Skip to content

Document forms and reports, macros, and object properties in the library documentation - #116

Merged
dominion525 merged 1 commit into
mainfrom
docs/lib-forms-macros-props
Oct 22, 2026
Merged

Document forms and reports, macros, and object properties in the library documentation#116
dominion525 merged 1 commit into
mainfrom
docs/lib-forms-macros-props

Conversation

@dominion525
@dominion525 dominion525 commented Oct 22, 2026
Copy link
Copy Markdown
Owner

Summary

  • The library documentation (lib_doc.md, of which docs/lib.md is a copy, and docs/lib.ja.md) had no word on reading forms and reports, macros, or object properties. Add a section for each, telling the functions that read them and the types they give, with an example that doctest builds
  • Forms and reports: list_forms and read_form_properties_of_type read the properties and the controls, with a word on read_form_type_info and read_form_stream
  • Macros: named, embedded and data macros are all read as MacroDef, with a word on data_macros_to_text and embedded_macro_to_text
  • Object properties: read_object_properties reads the groups of the object itself and of each column
  • The documentation of BlobProperty::name tells that bytes and GUIDs are named by bytes_prop_id_name

🤖 Generated with Claude Code

@dominion525 @claude
Document forms and reports, macros, and object properties in the libr…
ad7ca99 
…ary documentation

- Add three sections to lib_doc.md, of which docs/lib.md is a copy, and to docs/lib.ja.md, each telling the functions that read them and the types they give, with an example that doctest builds
- Forms and reports: list_forms and read_form_properties_of_type read the properties and the controls, with a word on read_form_type_info and read_form_stream
- Macros: named, embedded and data macros are all read as MacroDef, with a word on the functions that give the text of SaveAsText
- Object properties: read_object_properties reads the groups of the object itself and of each column
- Tell in the documentation of Blo
9611
bProperty::name that bytes and GUIDs are named by bytes_prop_id_name

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@dominion525 dominion525 mentioned this pull request Oct 22, 2026
Merged
@dominion525
dominion525 merged commit 702a487 into main Oct 22, 2026
10 checks passed
@dominion525
dominion525 deleted the docs/lib-forms-macros-props branch October 22, 2026 14:25
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

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@dominion525
0