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.

Sign up for GitHub

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

Jump to bottom

Fixes Issue 1829 #1830

Merged
merged 2 commits into from
Jul 1, 2024
Merged

Fixes Issue 1829 #1830

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50f5d07
fix: fixes a bug that could select wrong tag description markdown file
Kafkalasch Jun 17, 2024
a87ade4
fixes parser to be able to parse file names with and without ext
Kafkalasch Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions parser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -885,6 +885,13 @@ func isGeneralAPIComment(comments []string) bool {
}

func getMarkdownForTag(tagName string, dirPath string) ([]byte, error) {
if tagName == "" {
// this happens when parsing the @description.markdown attribute
// it will be called properly another time with tagName="api"
// so we can safely return an empty byte slice here
return make([]byte, 0), nil
}

dirEntries, err := os.ReadDir(dirPath)
if err != nil {
return nil, err
Expand All @@ -897,11 +904,12 @@ func getMarkdownForTag(tagName string, dirPath string) ([]byte, error) {

fileName := entry.Name()

if !strings.Contains(fileName, ".md") {
continue
expectedFileName := tagName
if !strings.HasSuffix(tagName, ".md") {
expectedFileName = tagName + ".md"
}

if strings.Contains(fileName, tagName) {
if fileName == expectedFileName {
fullPath := filepath.Join(dirPath, fileName)

commentInfo, err := os.ReadFile(fullPath)
Expand Down
Loading