sbt / sbt/website

Unexpected formatting for paragraph

Open
#722 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
73
Forks
351
Avg merge
5h 21m
Merged PRs (30d)
9

Description

Link: https://www.scala-sbt.org/1.x/docs/Multi-Project.html
Paragraph:

Each project’s settings can go in .sbt files in the base directory of that project, while the .scala file can be as simple as the one shown above, listing the projects and base directories. There is no need to put settings in the .scala file.* // what does this asterisk is used for?

Actual formatting:
image

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the Multi-Project documentation page linked in the issue and inspect the quoted paragraph and its rendered Markdown. Determine whether the trailing asterisk is intentional or an accidental formatting marker; done means the paragraph renders without the unexpected formatting and explains the asterisk’s purpose.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.