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 for v0.5.0 #145

Merged
merged 44 commits into from
Sep 3, 2023
Merged

Update docs for v0.5.0 #145

merged 44 commits into from
Sep 3, 2023

Conversation

edwardalee
Copy link
Contributor

@edwardalee edwardalee commented Jul 9, 2023

I have started a branch release-5 in which we should document changes that will become part of the 0.5.0 release. Off the top of my head, the following is a to-do list (this should be updated using the release notes). The checked items are either in this branch already or in main already. Please add to this list.

  • New parameter and state initialization syntax
  • New preamble architecture
  • math.h is included automatically in the C target
  • single-threaded and workers options in target and on the command line.
  • change indentation to two spaces instead of four.
  • add reset keyword for state variable.
  • add reset trigger for reactions.
  • document generic reactors in C
  • reaction declarations
  • fix Cpp description in Expressions.md once this bug is fixed.
  • fix Python description in Expressions.md once this bug is fixed (bug is not fixed. documented old syntax.)

@lhstrh lhstrh changed the title Update docs for release 5 Update docs for v0.5.0 Jul 9, 2023
@edwardalee edwardalee marked this pull request as ready for review August 12, 2023 14:40
@edwardalee edwardalee requested review from lhstrh and removed request for patilatharva August 12, 2023 14:40
@edwardalee edwardalee marked this pull request as draft August 30, 2023 12:27
@edwardalee edwardalee marked this pull request as ready for review September 2, 2023 18:54
@edwardalee
Copy link
Contributor Author

I have completed a pass on the docs. This is ready to review. When we merge it, I think the handbook will be up-to-date with release 0.5. Please merge.

@@ -1,23 +1,25 @@
target TypeScript {
// FIXME: This should work with timeout: 0 msec.
timeout: 1 msec
timeout: 1 msec // FIXME: This should work with timeout: 0 msec.
Copy link
Member

Choose a reason for hiding this comment

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

@edwardalee, I'm a little puzzled by this FIXME...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't add this comment, but I did notice that the other targets use a timeout of 0 for this test.

Copy link
Member

@lhstrh lhstrh left a comment

Choose a reason for hiding this comment

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

Thanks for working on this so tirelessly, @edwardalee!

@lhstrh lhstrh merged commit 1b317c1 into main Sep 3, 2023
1 check passed
@lhstrh lhstrh deleted the release-5 branch September 3, 2023 07:55
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