Skip to content

Conversation

Rohit-Kakodkar
Copy link
Collaborator

Description

Please describe the changes/features in this pull request.

  • Adds a custom documentation mode for Github Copilot chat (DocumenTor)
  • As an experiment, DocumenTor updated documentation for point::stress

To use the mode, select it within GitHub Copilot chat and tell it which class/function/file to document.

Issue Number

If there is an issue created for these changes, link it here

Checklist

Please make sure to check developer documentation on specfem docs.

  • I ran the code through pre-commit to check style
  • THE DOCUMENTATION BUILDS WITHOUT WARNINGS/ERRORS
  • I have added labels to the PR (see right hand side of the PR page)
  • My code passes all the integration tests
  • I have added sufficient unittests to test my changes
  • I have added/updated documentation for the changes I am proposing
  • I have updated CMakeLists to ensure my code builds
  • My code builds across all platforms

- [x] Adds a custom documentation mode for Github Copilot chat (DocumenTor)
- [x] As an experiment, `DocumenTor` updated documentation for `point::stress`
@Rohit-Kakodkar Rohit-Kakodkar added the documentation Improvements or additions to documentation label Sep 18, 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.

2 participants