Skip to content

Conversation

@Hatsunespica
Copy link
Collaborator

No description provided.

Copy link
Contributor

@math-fehr math-fehr left a comment

Choose a reason for hiding this comment

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

Thanks a lot!
I added some comments, feel free to ask me any questions!

I think that some functions should be probably moved somewhere more appropriate, for instance the function creating AndOp, or the function creating a CallOp with a check.

Otherwise, please document the functions a bit more, so I can more easily understand what they do and how they do it!

@Hatsunespica
Copy link
Collaborator Author

@math-fehr Hi Mathieu, I updated both files with comment, do you think I need to add more?

@math-fehr
Copy link
Contributor

Hey! Can you add them as docstrings with the """ quotes rather than as comments, so that they are shown in IDEs?
For class fields, they should be added right after the field, so something like this:

my_field: type
"""
Documentation for my_field
"""

@math-fehr
Copy link
Contributor

And for functions/classes, the docstrings should be added directly in the function scope.
For instance:

def my_func():
   """
   My documentation.
   """

Copy link
Contributor

@math-fehr math-fehr left a comment

Choose a reason for hiding this comment

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

I added some comments in the first file, can you please address some comments on the second file?

@Hatsunespica
Copy link
Collaborator Author

@math-fehr Thanks for your reviews! I accepted your changes, and updated my functions/fields as your suggested format. I think it's better now!

@Hatsunespica
Copy link
Collaborator Author

@math-fehr 0w0

@math-fehr
Copy link
Contributor

Sorry for the delay!
The first file looks good, can you also update / address the comments on the other file?

@Hatsunespica
Copy link
Collaborator Author

@math-fehr It's totally OK >w< .Thanks for looking both files! I added more comment for the other file. What do you think now?

1 similar comment
@Hatsunespica
Copy link
Collaborator Author

@math-fehr It's totally OK >w< .Thanks for looking both files! I added more comment for the other file. What do you think now?

@math-fehr
Copy link
Contributor

What I meant was addressing the comments I made earlier, like merging some functions, or removing some functions. They should be still on github, do you see them?

@math-fehr math-fehr merged commit 9ef927f into main Mar 11, 2025
2 checks passed
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