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.

Sign up for GitHub

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

Jump to bottom

Generated code with docstrings needs special care #1

Open
Azzaare opened this issue Mar 25, 2024 · 0 comments
Open

Generated code with docstrings needs special care #1

Azzaare opened this issue Mar 25, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Milestone
v1.0.0

Comments

@Azzaare
Copy link
Member

Azzaare commented Mar 25, 2024

As mentioned in the title, some functions, and methods generated through metaprogramming needs some special care regarding their documentation.

Two cases:

  1. Functions/methods defined with a macro call preceding it, such as: @unrolled function CompositionalNetworks.tr_in(...)
  2. Functions/methods generated anonymously, such as the ones in USUAL_CONSTRAINTS. Can we generate documentation?
@Azzaare Azzaare added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Mar 25, 2024
@Azzaare Azzaare added this to Opt Pot Mar 26, 2024
@Azzaare Azzaare moved this to Todo in Opt Pot Mar 26, 2024
@Azzaare Azzaare added this to the v1.0.0 milestone Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
Opt Pot
Status: Todo
Milestone
v1.0.0
Development

No branches or pull requests
1 participant
@Azzaare