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

Add Support for Documenting Modules #1900

Merged
merged 5 commits into from
Jul 26, 2021
Merged

Add Support for Documenting Modules #1900

merged 5 commits into from
Jul 26, 2021

Conversation

iamrecursion
Copy link
Contributor

Pull Request Description

This PR adds support for writing documentation at the top level of a module.

Important Notes

N/A

Checklist

Please include the following checklist in your PR:

  • The documentation has been updated if necessary.
  • All code conforms to the Scala, Java, and Rust style guides.
  • All documentation and configuration conforms to the markdown and YAML style guides.
  • All code has been tested where possible.

@iamrecursion iamrecursion added Type: Enhancement --breaking Important: a change that will break a public API or user-facing behaviour labels Jul 26, 2021
@iamrecursion iamrecursion requested review from 4e6 and kustosz July 26, 2021 10:46
@iamrecursion iamrecursion self-assigned this Jul 26, 2021
@iamrecursion iamrecursion marked this pull request as ready for review July 26, 2021 10:49
@iamrecursion iamrecursion requested a review from radeusgd as a code owner July 26, 2021 10:49
4e6
4e6 approved these changes Jul 26, 2021
View reviewed changes
Copy link
Contributor

@4e6 4e6 left a comment

Choose a reason for hiding this comment

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

Great!

engine/runtime/src/test/scala/org/enso/compiler/test/context/SuggestionBuilderTest.scala Show resolved Hide resolved
@iamrecursion iamrecursion merged commit bc96f0e into main Jul 26, 2021
@iamrecursion iamrecursion deleted the wip/ara/module-docs branch July 26, 2021 12:26
iamrecursion added a commit that referenced this pull request Jul 28, 2021
@iamrecursion
Add support for documenting modules (#1900)
56df0d3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kustosz kustosz kustosz approved these changes

@4e6 4e6 4e6 approved these changes

@radeusgd radeusgd Awaiting requested review from radeusgd

Assignees

@iamrecursion iamrecursion

Labels
--breaking Important: a change that will break a public API or user-facing behaviour
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@iamrecursion @4e6 @kustosz