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

Keyword documentation and some other improvements #241

Merged
merged 20 commits into from
Sep 27, 2022

Conversation

BlackDragonBE
Copy link
Contributor

  • Implemented the keyword system on the website end and replaced hardcoded URLS with keywords in this format: @[keyword](text to display)
  • @Grifs implemented the keyword system on the Viash CLI end, so it shows only the text part
  • Removed references to online documentation that aren't keywords
  • Replaced DSL with Dynamic Config Modding, since DCM uses a DSL but the concept itself isn't, this is more correct IMHO
  • Added an example for a Ruby setup based on the source code
  • Fixed formatting of ns exec documentation

@codecov
Copy link

codecov bot commented Sep 27, 2022

Codecov Report

Base: 84.91% // Head: 84.97% // Increases project coverage by +0.05% 🎉

Coverage data is based on head (476c7b0) compared to base (157da5e).
Patch coverage: 96.15% of modified lines in pull request are covered.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #241      +/-   ##
===========================================
+ Coverage    84.91%   84.97%   +0.05%     
===========================================
  Files           83       83              
  Lines         2857     2868      +11     
  Branches       165      184      +19     
===========================================
+ Hits          2426     2437      +11     
  Misses         431      431              
Impacted Files Coverage Δ
...n/scala/io/viash/functionality/Functionality.scala 90.90% <ø> (ø)
...main/scala/io/viash/platforms/DockerPlatform.scala 97.24% <ø> (ø)
...ala/io/viash/platforms/NextflowVdsl3Platform.scala 88.57% <ø> (ø)
...iash/platforms/requirements/RubyRequirements.scala 0.00% <ø> (ø)
...main/scala/io/viash/cli/DocumentedSubcommand.scala 82.25% <93.75%> (+3.82%) ⬆️
src/main/scala/io/viash/cli/CLIConf.scala 97.11% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@BlackDragonBE BlackDragonBE changed the base branch from main to develop September 27, 2022 07:17
@rcannood rcannood merged commit cda847c into develop Sep 27, 2022
@rcannood rcannood deleted the keyword_documentation branch September 28, 2022 06:29
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.

3 participants