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

Fix and update GenX documentation #189

Merged
merged 1 commit into from
Oct 25, 2023

Conversation

RuaridhMacd
Copy link
Collaborator

Description

This fixes the issue with DOLPHYN not properly pulling the GenX documentation.

The issue was that while GitHub sees GenX as a submodule, DOLPHYN sees GenX as part of its own code - not a module. This was set up this way to make it easier to overwrite code and avoid the need to export more functions.

Some problems remain. We'll create separate issue to address theseL

  • Some warnings still exist when compiling the documentation, due to incorrect markdown formatting in the doc strings.
  • Some GenX functions are missing documentation, which creates warnings
  • Some functions with docstrings are not being included in the documentation.

Fixes issue #

#180

Type of change

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

n / a

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have run tests with my code to avoid compatibility issues
  • Any dependent changes have been merged and published in downstream modules

The issue was that while GitHub sees GenX as a submodule, DOLPHYN sees GenX as part of it's own code - not a module. This was set up this way to make it easier to overwrite code and avoid the need to export more functions.
@RuaridhMacd RuaridhMacd linked an issue Oct 25, 2023 that may be closed by this pull request
@RuaridhMacd RuaridhMacd merged commit c40d3ec into main Oct 25, 2023
2 checks passed
@RuaridhMacd RuaridhMacd deleted the 180-missing-genx-documentation-in-main-branch branch October 25, 2023 02:51
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.

Missing GenX documentation in main branch
1 participant