Skip to content
This repository has been archived by the owner on Oct 17, 2024. It is now read-only.

Fix README formatting and example snippet #92

Merged
merged 1 commit into from
Jan 29, 2024

Conversation

parlough
Copy link
Contributor

@parlough parlough commented Jan 29, 2024

Fixes README formatting on pub.dev by removing unexpected tab characters. Also updates the example code in README to use correct variable name and be compatible with null safety.

Fixes dart-lang/core#398

@parlough parlough changed the title Fix README formatting Fix README formatting and example snippet Jan 29, 2024
@@ -93,30 +93,30 @@ Example:

```dart
// Using String indices.
String firstTagString(String source) {
var start = string.indexOf("<") + 1;
String? firstTagString(String source) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I do wonder how we can best provide (lightweight, simple) analysis for snippets in readme files.

@devoncarew devoncarew merged commit bb54478 into dart-archive:master Jan 29, 2024
9 checks passed
@parlough parlough deleted the fix/readme-formatting branch January 29, 2024 20:24
mosuem pushed a commit to dart-lang/core that referenced this pull request Oct 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

README.md is rendered incorrectly on pub.dev and in API docs
2 participants