Bug: Remove unsupported 'qualitySuffix' argument from GenerateImageInfer.build_generate() in documentation

[trojblue]

The example on readme had an option 'qualitySuffix':

qualitySuffix=True,

which was removed or not present in the actual generator:

novelai-python/src/novelai_python/sdk/ai/generate_image/__init__.py

Lines 696 to 697 in 904bf85

	def build_generate(
	prompt: str,

[sudoskys]

Ok, will change it in a moment, thanks for the report

[sudoskys]

This option was merged into quality Toggle in the previous version.

[sudoskys]

fixed in #100

[neutron-nerve]

Issue Closure Report for LlmKira/novelai-python: Unsupported 'qualitySuffix' Argument

Summary

The issue concerned the removal of an unsupported 'qualitySuffix' argument from the documentation example for the GenerateImageInfer.build_generate() method in the novelai-python repository. The argument was mistakenly included in the documentation but was absent in the actual code implementation.

Details

• Issue Originator: @trojblue
• Reported On: January 4, 2025
• Resolved By: @sudoskys
• Resolution Date: January 5, 2025

Problem Description

The documentation in the repository included the argument 'qualitySuffix' in an example, highlighting a discrepancy with the actual implementation, where this argument was missing from the GenerateImageInfer.build_generate() method.

Documentation Line Reference

• The erroneous inclusion was noted in the README.md, Lines 67-68.
• The correct implementation is located in the source code, Lines 696-697.

Resolution

The issue was addressed promptly by contributor @sudoskys, who removed the erroneous 'qualitySuffix': True entry from the README documentation. This correction ensured that the documentation is aligned with the source code, avoiding any potential confusion for the users.

Final Outcome

The alignment of the documentation with the existing codebase has been successfully achieved, effectively closing the issue. The solution was implemented in pull request #100.

---

We appreciate the vigilance of community members in identifying such discrepancies, and we extend our gratitude to @trojblue for reporting the issue and @sudoskys for the swift resolution.