Skip to content

Commit c94d90d

Browse files
authored
[#2391][#2992] Update User Guide and Clean Up Code (#2394)
Fix some minor bugs reported in the user guide and the file Update the customizingReports.md's blurb section and remove the debugging code left over in the `RepoBlurbMarkdownParser` file.
1 parent a948101 commit c94d90d

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

docs/ug/configFiles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,6 @@ This file allows you to specify blurbs for authors. These blurbs will be display
237237
* First line in section: Author's Git Host ID.
238238
* Second line onwards: Blurb content.
239239
* Delimiter: `<!--author-->`. Everything on the line after the delimiter will be ignored.
240-
* Sample: [author-blurbs.md(https://github.com/reposense/RepoSense/blob/master/docs/ug/author-blurbs.md)]
240+
* Sample: [author-blurbs.md](https://github.com/reposense/RepoSense/blob/master/docs/ug/author-blurbs.md)
241241

242242
</div>

docs/ug/customizingReports.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,16 @@ Do note that the width of the title is bound by the width of the left panel.
7575

7676
For more information on how to use Markdown, see the [Markdown Guide](https://www.markdownguide.org/).
7777

78-
#### Add blurbs for branches
79-
A blurb can be added for a repository branch by creating a file titled `blurbs.md` in the config directory. The blurbs will be visible when grouping by `Repo/Branch`. The format of the file is given below:
80-
{{ embed("Appendix: **Config files format**", "configFiles.md#section-blurbs") }}
78+
#### Add blurbs for branches or authors
79+
A blurb can be added for a repository or author by creating the respective blurb markdown files in the config directory.
80+
- For a repository:
81+
- Create a file titled `repo-blurbs.md` in the config directory. The format of the file is given below:
82+
{{ embed("Appendix: **Config files format**", "configFiles.md#section-repo-blurbs") }}
83+
- The blurbs will be visible when grouping by `Repo/Branch`.
84+
- For an author:
85+
- Create a file titled `author-blurbs.md` in the config directory. The format of the file is given below:
86+
{{ embed("Appendix: **Config files format**", "configFiles.md#section-author-blurbs") }}
87+
- The blurbs will be visible when grouping by `Author`.
8188

8289
Specifying the config directory can be done as follows:
8390
{{ embed("Appendix: **CLI syntax reference → `config` flag**", "cli.md#section-config") }}

src/main/java/reposense/parser/RepoBlurbMarkdownParser.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,6 @@ protected KeyRecord<String> extractKey(List<String> lines, int position) throws
4848

4949
url = lines.get(position++).strip();
5050
}
51-
System.out.println("url is " + url);
52-
System.out.println("position is " + position);
5351
new URL(url).toURI();
5452
return new KeyRecord<>(url, position);
5553
} catch (MalformedURLException | URISyntaxException ex) {

0 commit comments

Comments
 (0)