Library documentation through aiken docs
#185
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
So that we can separate libraries from executable modules if necessary.
rvcas
added
need for documentation
There was already a 'parse_sources' function, and 'parse' was actually more about typechecking than parsing.
This require slightly more work and has little benefits at this stage given that the sources are literally inlined in the docs.
|
See preview: https://aiken-lang.github.io/stdlib/ |
- light-mode uses catpuccin-latte - dark-mode uses catpuccin-mocha
rvcas
reviewed
Dec 17, 2022
crates/project/src/module.rs
Outdated
| impl CheckedModule { | ||
| pub fn is_library(&self) -> bool { | ||
| self.ast.definitions().any(|def| match def { | ||
| Definition::Fn(func_def) => VALIDATOR_NAMES.contains(&func_def.name.as_str()), |
There was a problem hiding this comment.
this check is confusing me a little. Can't we instead just check self.kind?
There was a problem hiding this comment.
It's actually unused. I figured in the end that we could also just generate docs for validators if they are any 🤷♀️
So this could/should be removed
rvcas
approved these changes
Dec 17, 2022
- [x] Display function arguments using a newline-multiline strategy
when the signature gets too long. For example:
```
union_with
( left left: AssocList<key, value>
, right right: AssocList<key, value>
, with with: fn(key, value, value) -> value
) -> AssocList<key, value>
```
- [x] Show type-aliases as type-aliases in signatures; provided
they've been specified as type annotations. Otherwise, fallback to
the inferred type.
- [x] Do not show argument names in signatures, but show labels when
they're present. This reflects more the original intent behind
labels (which are meant as public-facing documentation).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📍 Define 'is_library' for 'CheckedModule'
So that we can separate libraries from executable modules if necessary.
📍 Introduce 'docs' for generating documentation for aiken libraries.
📍 Add a 'docs' method to projects, using the newly introduced docs::generate_all
📍 Add command 'docs' for generating project documentation.
📍 Support data-types in documentation.
📍 Fix type-parameter pretty printing (use chevrons)
📍 Refactor project source parsing
There was already a 'parse_sources' function, and 'parse' was actually more about typechecking than parsing.
📍 Implement modules' extra, to get function & module comments in docs.
📍 Apply suggestions from clippy.
📍 Support module constants in docs.
📍 Define HighlightJS definition for Aiken.
📍 Do not show link to source.
This require slightly more work and has little benefits at this stage given that the sources are literally inlined in the docs.
📍 Factor out common module prefix when all modules are under a same namespace.
📍 Adjust docs theme to catppuccin
📍 Add source repository to config & docs.