Skip to content

docs(readme): fix namespace references #54

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

Open
nick-lay wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(readme): fix namespace references #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ dotnet add package QRCoder.Core
Generate your first QR code with just a few lines of code:

```csharp
using QRCoder.Core;
using SkiaSharp;
using QRCoder.Core.Generators;
using QRCoder.Core.Renderers;
Comment on lines +116 to +117

@devin-ai-integration devin-ai-integration Bot May 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚩 Bilingual docs not updated alongside README

The PR updates import statements in README.md code examples from using QRCoder.Core; / using SkiaSharp; to using QRCoder.Core.Generators; / using QRCoder.Core.Renderers;. However, the equivalent code examples in docs/en-US/usage-guide.md:54-55 and docs/pt-BR/guia-de-uso.md:54-55 still use the old imports (using QRCoder.Core; and using SkiaSharp;). The AGENTS.md DO rules include "Documentação bilíngue (pt-BR + en-US)", and these docs now show different (and likely incorrect) import statements compared to the README. This pre-existing inconsistency is now amplified by the PR — the README is correct while the docs remain stale.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

@devin-ai-integration devin-ai-integration Bot May 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 Info: Removal of using SkiaSharp; is safe due to var usage

The Quick Start example previously had using SkiaSharp; which was replaced by using QRCoder.Core.Renderers;. This is safe because the code example uses var for all SkiaSharp types (e.g., using var bitmap = qrCode.GetGraphic(10); where the return type is SKBitmap). No SkiaSharp type names are referenced explicitly anywhere in the README code examples. If a user wanted to extend these examples with explicit SkiaSharp types (like SKEncodedImageFormat), they would need to add using SkiaSharp; themselves — but the examples as written are self-consistent.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.


// Create the QR Code generator
using var generator = new QRCodeGenerator();
Expand Down Expand Up @@ -163,7 +163,7 @@ string psString = ps.GetGraphic(5);
### Payload Examples

```csharp
using QRCoder.Core;
using QRCoder.Core.Generators;

// Wi-Fi QR Code
var wifiPayload = new PayloadGenerator.WiFi("MyNetwork", "MyPassword",
Expand Down