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

Added more documentation. #17

Merged
merged 12 commits into from
Jul 5, 2024
Merged

Conversation

YouGuessedMyName
Copy link
Collaborator

I wasn't really sure what to do with state names. Don't they already kind of exist in the form of labels? I opted to delete them. What do you think? I added action labels using frozensets because they are hashable. The most important change was added documentation.

@linusheck
Copy link
Collaborator

I agree about not having state names. Frozensets are a good idea!

The point of the shorthand stuff was to create a transition without creating an object like this:

init.set_transitions(

I agree that the shorthand type is unreadable.

@linusheck
Copy link
Collaborator

linusheck commented Jul 3, 2024

Oh, there was a typo in the type. Can you change

TransitionShorthand = list[tuple[Number, State]]

to

TransitionShorthand = list[tuple[Number, State]] | list[tuple[Action, State]]

that was what that was supposed to say. Thanks :)

So you can easily add a transition like (0.5, s) or (action, s).

I should add a test about it.

@linusheck linusheck mentioned this pull request Jul 5, 2024
@YouGuessedMyName YouGuessedMyName merged commit 7971f39 into main Jul 5, 2024
2 checks passed
@linusheck linusheck deleted the 15-model-documentation-16-rewards branch July 12, 2024 08:52
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