Skip to content

Conversation

@diptorupd
Copy link
Contributor

@diptorupd diptorupd commented Mar 29, 2024

  • Have you provided a meaningful PR description?
    Python has no direct way of adding docstrings for global variables. To document all numba_dpex.config options on the documentation page, a rst file was being manually maintained. It resulted in the file not being updated much and being dated.

The PR updates the config.py to use annotations to put the documentation into the config options. Not perfect, but better than manually updating the rst file.

  • Have you added a test, reproducer or referred to an issue with a reproducer?
  • Have you tested your changes locally for CPU and GPU devices?
  • Have you made sure that new changes do not introduce compiler warnings?
  • If this PR is a work in progress, are you filing the PR as a draft?

Fixes #683

@diptorupd diptorupd requested a review from ZzEeKkAa March 29, 2024 22:40
@diptorupd
Copy link
Contributor Author

@ZzEeKkAa are we still using the TESTING_SKIP_NO_DEBUGGING flag? I do not see it being used anywhere and the gdb tests do run by default right now.

@diptorupd diptorupd force-pushed the docs/config_options branch from e211fb6 to 017b092 Compare March 29, 2024 22:42
@github-actions
Copy link
Contributor

Documentation preview: show.

@coveralls
Copy link
Collaborator

coveralls commented Mar 29, 2024

Coverage Status

coverage: 84.831% (+0.006%) from 84.825%
when pulling 017b092 on docs/config_options
into f6a79b4 on main.

@diptorupd diptorupd changed the title Docs/config options [Documentation] config options Mar 30, 2024
Copy link
Contributor

@ZzEeKkAa ZzEeKkAa left a comment

Choose a reason for hiding this comment

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

I love the way it is synced now. Not sure about TESTING_SKIP_NO_DEBUGGING.

@ZzEeKkAa ZzEeKkAa merged commit 5ff654f into main Apr 1, 2024
@ZzEeKkAa ZzEeKkAa deleted the docs/config_options branch April 1, 2024 15:56
@github-actions
Copy link
Contributor

github-actions bot commented Apr 1, 2024

Documentation preview removed.

github-actions bot added a commit that referenced this pull request Apr 1, 2024
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.

Add section for environment variables in documentation

3 participants