"Raises" section in autogenerated markdown, warning for uploading a package ending in _build
This commit is contained in:
@@ -1,2 +1,3 @@
|
||||
rich
|
||||
requests
|
||||
textual
|
||||
@@ -89,6 +89,8 @@ def build(args):
|
||||
f.write("- myArgument (double): describe your arguments in a list format like this.\n\n")
|
||||
f.write("## Returns\n")
|
||||
f.write("result (int): then explain what the function returns\n\n")
|
||||
f.write("## Raises\n")
|
||||
f.write("- `ErrorName`: have your error reason here, include this if your function raises any errors\n")
|
||||
f.write("## Example\n")
|
||||
f.write("```python\n")
|
||||
f.write("# then show how you use the function in an example\n")
|
||||
|
||||
@@ -28,6 +28,8 @@ def publish(args):
|
||||
if not os.path.isfile(os.path.join(args.folder_path, "mineral.ini")):
|
||||
console.print(f"[b red]digpkg: failed to publish mineral: mineral has no \"mineral.ini\" file")
|
||||
sys.exit(1)
|
||||
if os.path.basename(os.path.normpath(args.folder_path)).endswith("_build"):
|
||||
console.print(f"\n[b yellow]You didn't remove the \"_build\" suffix from your mineral's folder name!\n\nIf this is intentional you can ignore this message, however it is bad practice.\nIf this is not intentional, you will be unable to install your package properly using dig.[/]")
|
||||
|
||||
# ask for user and pass
|
||||
console.print("[b]Please authenticate.\n[/]")
|
||||
|
||||
Reference in New Issue
Block a user