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

Some BP5 Serialization documentation, mostly writer-side perspective. #4372

Merged
merged 1 commit into from
Oct 18, 2024

Conversation

eisenhauer
Copy link
Member

No description provided.

@eisenhauer eisenhauer enabled auto-merge (squash) October 17, 2024 21:04
Copy link
Contributor

@anagainaru anagainaru left a comment

Choose a reason for hiding this comment

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

I think this is great, we should have more of this type of documentation for developers. I'm just wondering if the code is the best place to have this. Could we have a separate location for developer level documentation?

@eisenhauer
Copy link
Member Author

Not opposed to a separate location certainly, though in some sense it might be easier to read when looking at code. Probably also want it versioned. So, if not in the code, maybe a developer_docs directory with entries in Markdown format? I worry a bit because I think stuff in the code is more likely to be updated as things change, but there's no perfect system there.

@eisenhauer eisenhauer merged commit f1febb7 into ornladios:master Oct 18, 2024
38 checks passed
@anagainaru
Copy link
Contributor

Something to discuss, I'll approve for now so this gets in. And we can pull it out if we decide to create such a place.

@eisenhauer eisenhauer deleted the BP5Doc branch October 18, 2024 00:25
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.

2 participants