Skip to content

📚 Improve Config class rdoc #296

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

Merged
merged 1 commit into from
Jun 14, 2024
Merged

📚 Improve Config class rdoc #296

merged 1 commit into from
Jun 14, 2024

Conversation

nevans
Copy link
Collaborator

@nevans nevans commented Jun 14, 2024

  • Convert back to rdoc markup (not markdown) by default. Only some config attributes will want markdown (for the tables).
  • Add inheritance examples. It's better to show than to just explain.

* Convert back to rdoc markup (not markdown) by default.  Only some
  config attributes will want markdown (for the tables).
* Add inheritance examples.  It's better to show than to just explain.
@nevans nevans merged commit 962671d into master Jun 14, 2024
26 checks passed
@nevans nevans deleted the config-rdoc-markup branch June 14, 2024 22:50
@nevans nevans added the documentation Improvements or additions to documentation label Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant