Skip to content

Minor Documentation Consistency Corrections - #592

Merged
pelesh merged 3 commits into
developfrom
lukel/math-last-fixes
Sep 29, 2026
Merged

Minor Documentation Consistency Corrections#592
pelesh merged 3 commits into
developfrom
lukel/math-last-fixes

Conversation

@lukelowry

@lukelowry lukelowry commented Sep 28, 2026

Copy link
Copy Markdown
Collaborator

Description

Closes #532 , this should be the last of them

Checklist

  • All tests pass.
  • Code compiles cleanly with flags -Wall -Wpedantic -Wconversion -Wextra.
  • The new code follows GridKit™ style guidelines.
  • NA There are unit tests for the new code.
  • The new code is documented.
  • NA The feature branch is rebased with respect to the target branch.
  • NA The CHANGELOG.md has been updated to reflect the changes. If this is a minor PR that is part of a larger fix already included in the file, state so.

Further comments

None

@lukelowry
lukelowry marked this pull request as ready for review September 28, 2026 16:34
@lukelowry

lukelowry commented Sep 28, 2026

Copy link
Copy Markdown
Collaborator Author

cc @pelesh

@lukelowry lukelowry added this to the Release 0.2 milestone Sep 28, 2026
shakedregev
shakedregev approved these changes Sep 29, 2026
View reviewed changes

@shakedregev shakedregev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good.

pelesh
pelesh requested changes Sep 29, 2026
View reviewed changes

@pelesh pelesh left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

For some reason readthedocs is not building correctly. See the log.

The same issue may be affecting #590.

shakedregev
shakedregev requested changes Sep 29, 2026
View reviewed changes

@shakedregev shakedregev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fix broken readthedocs

@lukelowry

lukelowry commented Sep 29, 2026

Copy link
Copy Markdown
Collaborator Author

Boom fixed

https://gridkit.readthedocs.io/en/lukel-math-last-fixes/

It was a docstring issue in Vector

@lukelowry
lukelowry force-pushed the lukel/math-last-fixes branch from da11b7b to 0360185 Compare September 29, 2026 21:15
@lukelowry

lukelowry commented Sep 29, 2026

Copy link
Copy Markdown
Collaborator Author

Rebased and ready

pelesh
pelesh reviewed Sep 29, 2026
View reviewed changes
Comment thread docs/application/README.md
@pelesh
pelesh requested a review from shakedregev September 29, 2026 22:13
@pelesh
pelesh merged commit 776ffed into develop Sep 29, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pelesh pelesh pelesh approved these changes
@shakedregev shakedregev Awaiting requested review from shakedregev

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

Release 0.2

Development

Successfully merging this pull request may close these issues.

Documentation improvements for EMT & PhasorDynamics

3 participants

@lukelowry @pelesh @shakedregev