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

Fix multi-line DSL options in reactor cheat sheet docs #973

Closed
zachdaniel opened this issue Apr 4, 2024 · 0 comments · Fixed by #974
Closed

Fix multi-line DSL options in reactor cheat sheet docs #973

zachdaniel opened this issue Apr 4, 2024 · 0 comments · Fixed by #974
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@zachdaniel
Copy link
Contributor

zachdaniel commented Apr 4, 2024

When running mix docs we get a bunch of these warnings from spark telling us to move our docs out of the reference and into something else. Either we need to loosen this restriction or we need to address it.

warning: Multi-line DSL option doc detected. Please move contextual information into the
doc of a section, entity or module.
What to do when the reactor is undoing it's work?

* `always` - The undo action will always be run.
* `never` - The action will never be undone.
* `outside_transaction` - The action will only be undone if not running inside a transaction.

  (spark 2.1.7) lib/spark/cheat_sheet.ex:286: Spark.CheatSheet.escape_pipes/1
  (spark 2.1.7) lib/spark/cheat_sheet.ex:266: anonymous fn/2 in Spark.CheatSheet.do_options_table/3
  (elixir 1.16.2) lib/enum.ex:1801: anonymous fn/2 in Enum.map_join/3
  (elixir 1.16.2) lib/enum.ex:4378: Enum.map_intersperse_list/3
  (elixir 1.16.2) lib/enum.ex:4381: Enum.map_intersperse_list/3
  (elixir 1.16.2) lib/enum.ex:1801: Enum.map_join/3
@zachdaniel zachdaniel added the documentation Improvements or additions to documentation label Apr 4, 2024
@zachdaniel zachdaniel assigned zachdaniel and jimsynz and unassigned zachdaniel Apr 4, 2024
jimsynz added a commit that referenced this issue Apr 4, 2024
zachdaniel pushed a commit that referenced this issue Apr 4, 2024
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
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants