Fixed doc format of QueryBasedSliceFunction

[kevinmessiaen]

Description

Fixed doc format of QueryBasedSliceFunction

Related Issue

Type of Change

• 📚 Examples / docs / tutorials / dependencies update
• 🔧 Bug fix (non-breaking change which fixes an issue)
• 🥂 Improvement (non-breaking change which improves an existing feature)
• 🚀 New feature (non-breaking change which adds functionality)
• 💥 Breaking change (fix or feature that would cause existing functionality to change)
• 🔐 Security fix

Checklist

• I've read the CODE_OF_CONDUCT.md document.
• I've read the CONTRIBUTING.md guide.
• I've updated the code style using make codestyle.
• I've written tests for all new methods and classes that I created.
• I've written the docstring in Google format for all the methods and classes that I used.

[linear]

GSK-2328 Uploaded `QueryBasedSliceFunction` have a wrong doc format

[Inokinoki]

Nice catch!

At very first, I tried to catch the parsing issue in python-doc.utils.ts Hub frontend like:

export function extractArgumentDocumentation(callable: CallableDTO | null): ParsedDocstring {
  if (!callable?.doc) {
    return { body: '', args: {} };
  }

  try {
    let parsedDoc = JSON.parse(callable.doc);
    return {
      body: parsedDoc.description ?? '',
      args: parsedDoc.parameters ?? {},
    };
  } catch (e) {
    // Doc is a pure text
    return {
      body: callable.doc,
      args: {},
    }
  }
}

And the DB migration from Bazire saved me.

I think the yours is a promising way to prevent future issues.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

100.0% Coverage
0.0% Duplication