Skip to content

Commit 5e7af22

Browse files
committed
fix: Fix check command's Markdown output format not displaying parameter names
1 parent 6842372 commit 5e7af22

1 file changed

Lines changed: 33 additions & 9 deletions

File tree

src/_griffe/diff.py

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -195,12 +195,12 @@ def _explain_verbose(self) -> str:
195195
return "\n".join(lines)
196196

197197
def _explain_markdown(self) -> str:
198-
explanation = f"- `{self._canonical_path}`: *{self.kind.value}*"
198+
explanation = f"- `{self._relative_path}`: *{self.kind.value}*"
199199
old = self._format_old_value()
200-
if old != "unset":
200+
if old and old != "unset":
201201
old = f"`{old}`"
202202
new = self._format_new_value()
203-
if new != "unset":
203+
if new and new != "unset":
204204
new = f"`{new}`"
205205
if old and new:
206206
change = f"{old} -> {new}"
@@ -242,8 +242,12 @@ class ParameterMovedBreakage(Breakage):
242242

243243
kind: BreakageKind = BreakageKind.PARAMETER_MOVED
244244

245+
@property
246+
def _relative_path(self) -> str:
247+
return f"{super()._relative_path}({self.old_value.name})"
248+
245249
def _format_title(self) -> str:
246-
return f"{self._relative_path}({Fore.BLUE}{self.old_value.name}{Fore.RESET})"
250+
return f"{super()._relative_path}({Fore.BLUE}{self.old_value.name}{Fore.RESET})"
247251

248252
def _format_old_value(self) -> str:
249253
return ""
@@ -257,8 +261,12 @@ class ParameterRemovedBreakage(Breakage):
257261

258262
kind: BreakageKind = BreakageKind.PARAMETER_REMOVED
259263

264+
@property
265+
def _relative_path(self) -> str:
266+
return f"{super()._relative_path}({self.old_value.name})"
267+
260268
def _format_title(self) -> str:
261-
return f"{self._relative_path}({Fore.BLUE}{self.old_value.name}{Fore.RESET})"
269+
return f"{super()._relative_path}({Fore.BLUE}{self.old_value.name}{Fore.RESET})"
262270

263271
def _format_old_value(self) -> str:
264272
return ""
@@ -272,8 +280,12 @@ class ParameterChangedKindBreakage(Breakage):
272280

273281
kind: BreakageKind = BreakageKind.PARAMETER_CHANGED_KIND
274282

283+
@property
284+
def _relative_path(self) -> str:
285+
return f"{super()._relative_path}({self.old_value.name})"
286+
275287
def _format_title(self) -> str:
276-
return f"{self._relative_path}({Fore.BLUE}{self.old_value.name}{Fore.RESET})"
288+
return f"{super()._relative_path}({Fore.BLUE}{self.old_value.name}{Fore.RESET})"
277289

278290
def _format_old_value(self) -> str:
279291
return str(self.old_value.kind.value)
@@ -287,8 +299,12 @@ class ParameterChangedDefaultBreakage(Breakage):
287299

288300
kind: BreakageKind = BreakageKind.PARAMETER_CHANGED_DEFAULT
289301

302+
@property
303+
def _relative_path(self) -> str:
304+
return f"{super()._relative_path}({self.old_value.name})"
305+
290306
def _format_title(self) -> str:
291-
return f"{self._relative_path}({Fore.BLUE}{self.old_value.name}{Fore.RESET})"
307+
return f"{super()._relative_path}({Fore.BLUE}{self.old_value.name}{Fore.RESET})"
292308

293309
def _format_old_value(self) -> str:
294310
return str(self.old_value.default)
@@ -302,8 +318,12 @@ class ParameterChangedRequiredBreakage(Breakage):
302318

303319
kind: BreakageKind = BreakageKind.PARAMETER_CHANGED_REQUIRED
304320

321+
@property
322+
def _relative_path(self) -> str:
323+
return f"{super()._relative_path}({self.old_value.name})"
324+
305325
def _format_title(self) -> str:
306-
return f"{self._relative_path}({Fore.BLUE}{self.old_value.name}{Fore.RESET})"
326+
return f"{super()._relative_path}({Fore.BLUE}{self.old_value.name}{Fore.RESET})"
307327

308328
def _format_old_value(self) -> str:
309329
return ""
@@ -317,8 +337,12 @@ class ParameterAddedRequiredBreakage(Breakage):
317337

318338
kind: BreakageKind = BreakageKind.PARAMETER_ADDED_REQUIRED
319339

340+
@property
341+
def _relative_path(self) -> str:
342+
return f"{super()._relative_path}({self.new_value.name})"
343+
320344
def _format_title(self) -> str:
321-
return f"{self._relative_path}({Fore.BLUE}{self.new_value.name}{Fore.RESET})"
345+
return f"{super()._relative_path}({Fore.BLUE}{self.new_value.name}{Fore.RESET})"
322346

323347
def _format_old_value(self) -> str:
324348
return ""

0 commit comments

Comments
 (0)