profile
viewpoint
Mattt mattt @Flight-School Portland, OR https://flight.school Founder of @Flight-School and @NSHipster.

apple/swift 52882

The Swift Programming Language

apple/swift-evolution 11362

This maintains proposals for changes and user-visible enhancements to the Swift Programming Language.

apple/swift-package-manager 7880

The Package Manager for the Swift Programming Language

Jounce/Surge 4753

A Swift library that uses the Accelerate framework to provide high-performance functions for matrix math, digital signal processing, and image manipulation.

FormatterKit/FormatterKit 4210

`stringWithFormat:` for the sophisticated hacker set

apple/swift-corelibs-foundation 3955

The Foundation Project, providing core utilities, internationalization, and OS independence

apple/swift-corelibs-libdispatch 1854

The libdispatch Project, (a.k.a. Grand Central Dispatch), for concurrency on multicore hardware

mattt/CargoBay 1789

The Essential StoreKit Companion

mattt/AnimatedGIFImageSerialization 1084

Complete Animated GIF Support for iOS, with Functions, NSJSONSerialization-style Class, and (Optional) UIImage Swizzling

apple/swift-corelibs-xctest 846

The XCTest Project, A Swift core library for providing unit test support

startedcyluxx/robula-plus

started time in 2 hours

startedRoaringBitmap/SwiftRoaring

started time in 12 hours

issue commentSwiftDocOrg/swift-doc

Help wanted: Integrating with git hooks

Hey @kandelvijaya, to answer your questions:

  1. Is there any better way to integrate this doc generation on git-hooks level?

I wouldn't recommend git-hooks for this. A CI/CD system like GitHub Actions is a much better fit, I think.

  1. If you believe we can ignore the timestamp conditionally then how can i help support you?

Why don't you want the timestamp to be updated?

kandelvijaya

comment created time in 14 hours

push eventOld-Growth/timber-cruise-ruby-getting-started

Mattt

commit sha 56254890bf43b569a82a67daf06a59df5991de89

Return 500 on error

view details

push time in a day

issue commentSwiftDocOrg/swift-doc

Add space between property name and its description

Thanks for clarifying, @davegomez. I've been doing web development for a long time and am no stranger to browser quirks, but this is weird and unexpected.

According to the GFM spec:

6.13 Soft line breaks

A regular line break (not in a code span or HTML tag) that is not preceded by two or more spaces or a backslash is parsed as a softbreak. (A softbreak may be rendered in HTML either as a line ending or as a space. The result will be the same in browsers. In the examples here, a line ending will be used.)

A conforming parser may render a soft line break in HTML either as a line break or as a space.

I can't say for sure, but I believe GitHub uses this library to render markdown on the site. I'm not 100% sure whether Wiki is doing something different.

Here's some Ruby code I used to try to reproduce this locally:

require 'github/markup'
GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, File.read(/Home.md"))

Running the code produces the following:

<!-- Snip -->
<li><a href=\"./Class\">Class</a>:​\nA class declaration.</li>
<!-- Snip -->

<details> <summary>Full HTML Output</summary>

<h1>Types</h1>\n<ul>\n<li><a href=\"./DeclarationCollector\">DeclarationCollector</a>:​\nA Swift syntax visitor that collects declarations.</li>\n<li><a href=\"./AssociatedType\">AssociatedType</a>:​\nAn associated type declaration.</li>\n<li><a href=\"./Class\">Class</a>:​\nA class declaration.</li>\n<li><a href=\"./ConditionalCompilationBlock\">ConditionalCompilationBlock</a>:​\nA conditional compilation block declaration.</li>\n<li><a href=\"./ConditionalCompilationBlock_Branch\">ConditionalCompilationBlock.Branch</a>:​\nA conditional compilation block branch.</li>\n<li><a href=\"./Deinitializer\">Deinitializer</a>:​\nA class deinitializer declaration.</li>\n<li><a href=\"./Enumeration\">Enumeration</a>:​\nAn enumeration declaration.</li>\n<li><a href=\"./Enumeration_Case\">Enumeration.Case</a>:​\nAn enumeration case.</li>\n<li><a href=\"./Extension\">Extension</a>:​\nAn extension declaration.</li>\n<li><a href=\"./Function\">Function</a>:​\nA function declaration.</li>\n<li><a href=\"./Function_Signature\">Function.Signature</a>:​\nA function signature.</li>\n<li><a href=\"./Function_Parameter\">Function.Parameter</a>:​\nA function parameter.</li>\n<li><a href=\"./Import\">Import</a>:​\nAn import declaration.</li>\n<li><a href=\"./Initializer\">Initializer</a>:​\nAn initializer declaration.</li>\n<li><a href=\"./Operator\">Operator</a>:​\nAn operator declaration.</li>\n<li><a href=\"./Operator_Kind\">Operator.Kind</a>:​\nThe kind of operator (prefix, infix, or postfix).</li>\n<li><a href=\"./PrecedenceGroup\">PrecedenceGroup</a>:​\nAn operator precedence group declaration.</li>\n<li><a href=\"./PrecedenceGroup_Associativity\">PrecedenceGroup.Associativity</a>:​\nThe associativity of an operator,\nwhich determines how operators of the same precedence\nare grouped in the absence of parentheses.</li>\n<li><a href=\"./PrecedenceGroup_Relation\">PrecedenceGroup.Relation</a>:​\nThe relation of operators to operators in other precedence groups,\nwhich determines the order in which\noperators of different precedence groups are evaluated\nin absence of parentheses.</li>\n<li><a href=\"./Protocol\">Protocol</a>:​\nA protocol declaration.</li>\n<li><a href=\"./Structure\">Structure</a>:​\nA structure declaration.</li>\n<li><a href=\"./Subscript\">Subscript</a>:​\nA subscript declaration.</li>\n<li><a href=\"./Typealias\">Typealias</a>:​\nA type alias declaration.</li>\n<li><a href=\"./Variable\">Variable</a>:​\nA declaration for a property or a top-level variable or constant.</li>\n<li><a href=\"./Variable_Accessor\">Variable.Accessor</a>:​\nA computed variable or computed property accessor.</li>\n<li><a href=\"./Variable_Accessor_Kind\">Variable.Accessor.Kind</a>:​\nThe kind of accessor (<code>get</code> or <code>set</code>).</li>\n<li><a href=\"./Attribute\">Attribute</a>:​\nA declaration attribute.</li>\n<li><a href=\"./Attribute_Argument\">Attribute.Argument</a>:​\nAn attribute argument.</li>\n<li><a href=\"./GenericParameter\">GenericParameter</a>:​\nA generic parameter.</li>\n<li><a href=\"./GenericRequirement\">GenericRequirement</a>:​\nA generic requirement.</li>\n<li><a href=\"./GenericRequirement_Relation\">GenericRequirement.Relation</a>:​\nA relation between the two types identified\nin the generic requirement.</li>\n<li><a href=\"./Modifier\">Modifier</a>:​\nA declaration modifier.</li>\n</ul>\n<h1>Protocols</h1>\n<ul>\n<li><a href=\"./Declaration\">Declaration</a>:​\nA Swift declaration.</li>\n<li><a href=\"./ExpressibleBySyntax\">ExpressibleBySyntax</a>:​\nA type that can be initialized with a Swift syntax node.</li>\n</ul>

</details>

The relevant detail here is the newline after the colons. In HTML, whitespace characters — including newlines — are collapsed into a single space between inline elements, which Safari appears to be doing (correctly). I could be missing something obvious, but I don't understand why Chrome and Firefox are behaving any differently.

Saving the output to a local file and opening in Safari, Chrome, and Firefox, I'm able to reproduce the behavior we see on GitHub with this minimal example. Searching around for any explanation hasn't yielded anything other than entry-level Stack Overflow questions about <br/> tags and the like...


So yeah, I'm genuinely curious about what's going on. But short of patching major browser engines, I want to make this work for SwiftDoc. I believe the fix should be as simple as bringing the interpolated summary on the same line as the link, and will have a PR to do that soon.

davegomez

comment created time in 2 days

pull request commentSwiftDocOrg/swift-doc

Dark theme

Nice work, @literalpie! I look forward to checking this out in the next day or two. In the meantime, and for posterity, would you mind sharing a few screenshots here?

literalpie

comment created time in 2 days

delete branch SwiftDocOrg/swift-doc

delete branch : version-bump-1.0.0-beta.4

delete time in 3 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha 57e4008a2d734104110155e3ae07e6ac650bca71

Update version constant for swift-doc command (#159) * Update version constant for swift-doc command * Add changelog entry for #159

view details

push time in 3 days

PR merged SwiftDocOrg/swift-doc

Update version constant for swift-doc command

Because of course manual release processes are error-prone.

+6 -1

0 comment

2 changed files

mattt

pr closed time in 3 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha 28b30f2a591afdb3655f443739a0bd5dd4826cee

Add changelog entry for #159

view details

push time in 3 days

PR opened SwiftDocOrg/swift-doc

Update version constant for swift-doc command

Because of course manual release processes are error-prone.

+1 -1

0 comment

1 changed file

pr created time in 3 days

create barnchSwiftDocOrg/swift-doc

branch : version-bump-1.0.0-beta.4

created branch time in 3 days

GollumEvent

delete branch SwiftDocOrg/SwiftSemantics

delete branch : workflow_dispatch

delete time in 3 days

push eventSwiftDocOrg/SwiftSemantics

Mattt

commit sha 7c51ebd4967c9e2ac9d18b7d7f1c177862ab0f31

Trigger documentation workflow on workflow_dispatch

view details

Mattt

commit sha 29cc6abef52cc8815d14cb1e7be2c7fc9315c38c

Merge pull request #8 from SwiftDocOrg/workflow_dispatch Trigger documentation workflow on workflow_dispatch

view details

push time in 3 days

create barnchSwiftDocOrg/SwiftSemantics

branch : workflow_dispatch

created branch time in 3 days

GollumEvent

issue commentSwiftDocOrg/swift-doc

Add space between property name and its description

Hi @davegomez. I'm unable to reproduce this issue. I just regenerated the documentation for SwiftSemantics, and everything looks fine.

Jumping into the code, here's the part responsible for what you'd see on the Home page in the wiki:

https://github.com/SwiftDocOrg/swift-doc/blob/581af2fe50667ed2f49c53d26b91a8feb4531302/Sources/swift-doc/Supporting%20Types/Pages/HomePage.swift#L69

Here's the relevant line in the Abstract component:

https://github.com/SwiftDocOrg/swift-doc/blob/581af2fe50667ed2f49c53d26b91a8feb4531302/Sources/swift-doc/Supporting%20Types/Components/Abstract.swift#L23-L26

As you can see, there's a newline separating the colon and description, which is interpreted in CommonMark as a soft break and typically rendered as a space.

Could you please share more details about how you got these results?

davegomez

comment created time in 3 days

GollumEvent

startedJetBrains/swot

started time in 4 days

issue commentSwiftDocOrg/swift-doc

Feature request: publish prebuilt Docker image to Docker Hub to speed up the GitHub Action

@hallee Now that beta 4 is out, I'll work to get an official Docker image released and hook that up to the GitHub action (which, for better or for worse, tracks master rather than another branch or a tag).

hallee

comment created time in 4 days

release SwiftDocOrg/swift-doc

1.0.0-beta.4

released time in 4 days

push eventSwiftDocOrg/homebrew-formulae

Mattt

commit sha d5253d21368b9fac1463a798c6d611da3ed2ce22

Update formula swift-doc to 1.0.0-beta.4

view details

push time in 4 days

created tagSwiftDocOrg/swift-doc

tag1.0.0-beta.4

Generates documentation for Swift projects

created time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha 581af2fe50667ed2f49c53d26b91a8feb4531302

Bump version to 1.0.0-beta.4

view details

push time in 4 days

delete branch SwiftDocOrg/swift-doc

delete branch : fix-parameter-descriptions

delete time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha ffa22e82c7b3abec40a145937986005b571f7dae

Fix markup for parameter descriptions in HTML output (#156) * Remove extra </td> tag * Render parameter documentation content instead of description * Add changelog entry for #156

view details

push time in 4 days

issue closedSwiftDocOrg/swift-doc

Parameters showing as bulleted list

The descriptions for parameters are being rendered as items in an unordered list, but they should be in a paragraph.

Screen Shot 2020-07-31 at 12 04 50

closed time in 4 days

mattt

delete branch SwiftDocOrg/swift-doc

delete branch : ci-cache-dependencies

delete time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha b9c405d8ac64368e0811f63fdb5b98036e1d95e8

Add cache step to CI jobs (#157)

view details

Mattt

commit sha be9aafef7a1ae1e8c23addea351465323aec6fe4

Merge branch 'master' into fix-parameter-descriptions

view details

push time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha b9c405d8ac64368e0811f63fdb5b98036e1d95e8

Add cache step to CI jobs (#157)

view details

push time in 4 days

PR merged SwiftDocOrg/swift-doc

Add cache step to CI jobs chore

See https://docs.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows

+13 -1

0 comment

1 changed file

mattt

pr closed time in 4 days

PR opened SwiftDocOrg/swift-doc

Add cache step to CI jobs

See https://docs.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows

+13 -1

0 comment

1 changed file

pr created time in 4 days

create barnchSwiftDocOrg/swift-doc

branch : ci-cache-dependencies

created branch time in 4 days

push eventSwiftDocOrg/swift-doc

Zhiyu Zhu/朱智语

commit sha ed4a68069718aaa140ca2b7335cfa44daeba6225

Generate docs only for public symbols (#116) * Generate only for public symbols * Get extension from property * Assume unkown is public If you can access it from not where it's defined, it should be public. This fixes protocol conformances not showing up. Co-authored-by: Mattt <mattt@me.com>

view details

Mattt

commit sha 4898aa273ac2c6337ba6820ae6626660a39c1c66

Update changelog entry for #116

view details

Mattt

commit sha bf51a28365c1905b091d7c16ccd231b0808ddf22

Merge branch 'master' into fix-parameter-descriptions

view details

push time in 4 days

GollumEvent

push eventSwiftDocOrg/swift-doc

Mattt

commit sha 4898aa273ac2c6337ba6820ae6626660a39c1c66

Update changelog entry for #116

view details

push time in 4 days

push eventSwiftDocOrg/swift-doc

Zhiyu Zhu/朱智语

commit sha ed4a68069718aaa140ca2b7335cfa44daeba6225

Generate docs only for public symbols (#116) * Generate only for public symbols * Get extension from property * Assume unkown is public If you can access it from not where it's defined, it should be public. This fixes protocol conformances not showing up. Co-authored-by: Mattt <mattt@me.com>

view details

push time in 4 days

PR merged SwiftDocOrg/swift-doc

Generate docs only for public symbols

Changes

  • Renders only symbols that are public
  • To fix problem with protocol conformances not showing up, now assumes Unknown isPublic. This is a little shaky, but if we can use it without knowing the source, it should be public, right?

Before

image

# Where private declarations are shown:

image

# And because Node is private, when clicking on it, you'll get:

image

After

image

<details> <summary>Full TOC now don't have private members</summary>

image

</details>

+10 -5

2 comments

3 changed files

ApolloZhu

pr closed time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha 0b3f0458d777d52dffc58aa1a5e8e30a7447aa41

Add changelog entry for #156

view details

push time in 4 days

PR opened SwiftDocOrg/swift-doc

Fix parameter descriptions

Resolves #155

Before

Screen Shot 2020-07-31 at 12 04 50

After

Screen Shot 2020-07-31 at 13 12 36

+2 -2

0 comment

1 changed file

pr created time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha 87ac96149d54a97ddabec7be1782c243afb3a839

Render parameter documentation content instead of description

view details

push time in 4 days

create barnchSwiftDocOrg/swift-doc

branch : fix-parameter-descriptions

created branch time in 4 days

issue openedSwiftDocOrg/swift-doc

Parameters showing as bulleted list

The descriptions for parameters are being rendered as items in an unordered list, but they should be in a paragraph.

Screen Shot 2020-07-31 at 12 04 50

created time in 4 days

pull request commentSwiftDocOrg/swift-doc

Generate docs only for public symbols

Sorry for not getting to this sooner, @ApolloZhu. This is an excellent PR, and am very happy to get this into the forthcoming beta release. Thank you!

ApolloZhu

comment created time in 4 days

push eventApolloZhu/swift-doc

Max Desiatov

commit sha 58b314094758e6e6b8dddb4f540652f715341db7

Fix typo in README.md

view details

Mattt

commit sha d75fad6b3698cb8b9112177b37325e791fb67c21

Merge pull request #135 from MaxDesiatov/patch-1 Fix typo in README.md

view details

Jaap Wijnen

commit sha cb58c93c02e7a0383fee322dead2f706b6328860

add import (#140) * add import * linux only fix * update packages * update to GraphViz 0.1.2 * update Package.resolved * Add Changelog entry Co-authored-by: Mattt <mattt@me.com>

view details

dependabot[bot]

commit sha d6b9b664f443b94de220cff05238379d4fa7ae35

Bump lodash from 4.17.15 to 4.17.19 in /.node (#143) Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](https://github.com/lodash/lodash/compare/4.17.15...4.17.19) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Mattt <mattt@me.com>

view details

Mattt

commit sha 10786b0ff3cca988c15511a6779ee3298ee2d724

Install libcurl4-openssl-dev

view details

Brandon Williams

commit sha b815728d634582d8fdd5e4eb14ea68b1cdd43774

Use pre instead of pre-line for code whitespace. (#144) * Use pre instead of pre-line for code whitespace. * Add changelog entry for #144 Co-authored-by: Mattt <mattt@me.com>

view details

Mathew Polzin

commit sha 682f95d884112a2ec88699f56c5de8ba2177a29b

Bugfix/relative links (#127) * Fix relative link generation. * Expose base-url argument for GitHub action. * fix #134: crash for operator functions when no baseURL. Fixes crashes like this one: ```bash $ swift doc generate my-repo/Sources --module-name MyRepo 2020-06-30T17:00:13-0400 critical: Unable to construct path for /(lhs:rhs:) with baseURL / Fatal error: file /private/tmp/swift-doc-20200630-24417-jrxtfw/Sources/swift-doc/Supporting Types/Page.swift, line 55 zsh: illegal hardware instruction swift doc generate my-repo/Sources --module-name MyRepo ``` * swap out path for absoluteString to ensure that both relative and absolute URLs are supported as documentation paths. * Move path helper functions to SwiftDoc module * Add PathTests * Add assertions for function identifiers See #134 * Add changelog entry for #127 Co-authored-by: Kare Morstol <kare@nottoobadsoftware.com> Co-authored-by: Mattt <mattt@me.com>

view details

Andrew Chang

commit sha 6fe449ca0745f13591d6667686c9007d9cc38244

Only show scrollbars when needed (#132) * Only show scrollbars when needed Changes `overflow: scroll` to `overflow: auto` so that scroll bars only appear if the content is scrollable. This primarily affects macOS users who opt to always show scroll bars for accessibility reasons (and users on platforms that don't auto-hide scroll bars). * Regenerate all.min.css * Add changelog entry for #132 Co-authored-by: Mattt <mattt@me.com>

view details

Mattt

commit sha bcab20a97c8df04075572dedc90635ac5bc3c521

Fix sidebar icons, Add associated type icon (#145) * Fix type determination for requirements in HTML output * Add associatedtype icon to CSS * Fix determination of sidebar list item class * Add changelog entries for #145

view details

Matt Kiazyk

commit sha 8821e6cc2300b2e6ae3ef81d5b54cac70a4616df

Regression - private subclasses showing (#131) * Fix bug with private subclasses showing * Add changelog entries for #131 Co-authored-by: Mattt <mattt@me.com>

view details

Mattt

commit sha 2ef54e281c4bdde7de918f882b4ffb421f27b37b

Fix display of bullet list items in documentation discussion parts (#130) * Update dependencies * Update use of CommonMark builder interface * Add changelog entries for #130

view details

Yoshimasa Niwa

commit sha 2f79e9797ed6b2b2dddfd936a1fd4c3516d485a7

FIX: swift-doc creates file and directory with unexpected permission (#146) * FIX: swift-doc creates file and directory with unexpected permission **Problem** swift-doc creates file with execution bit, also creates directory without execution bit. **Solution** Remove unexpected permission attributes given to the `FileManager` and let them to use file system defaults. * Update changelog.

view details

Mattt

commit sha 7bdcbc5e798d57c6ba5b9667262e5b7759eab4f5

Omit initializer expression if closure or function call to ensure sonable declaration code blocks (#150) * Omit initializer expression if closure or function call to ensure reasonable declaration code blocks. Resolves #138 * Add changelog entry for #150

view details

Mattt

commit sha aeed63c32484dc298bd12accc087b1c65ecb8b0d

Add zero width space to escape emoji shortcodes (#149) * Add zero width space to escape emoji shortcodes * Add changelog entries for #149

view details

Mattt

commit sha 00f2787e36675d6f3212e83b7ecb1e5fbc8f461d

Add test that non-public members aren't included in generated documentation (#151) Verifies #136

view details

Mattt

commit sha f83e8984e9dee76cdba10acf930d292cf49b8935

Fix visual regression for adjacent linked tokens in code block (#152) * Fix visual regression for adjacent linked tokens in code block * Add changelog entry for #152

view details

Mattt

commit sha aade6f98ae53d2ef8ff7b444d8f04830116dca7f

Add missing links for nodes in relationship graph (#153)

view details

Mattt

commit sha 8b1a8a1af967750ead82a15950c52aff5d26c19f

Add changelog entry for #153

view details

Mattt

commit sha a6e636aa5b4ddb0a7243936046bba1de0195ce34

Merge branch 'master' into master

view details

push time in 4 days

issue closedSwiftDocOrg/swift-doc

Add the ability to select the access control level to document.

I am looking for the configuration to select what level of access control we want to document. For example, for now, the documentation only works for Public/Open stuff, and that makes sense for most projects. But there some cases where would be useful document internal stuff.

Thanks in advance.

closed time in 4 days

dnlosx

issue commentSwiftDocOrg/swift-doc

Add the ability to select the access control level to document.

Thanks for writing in, @dnlosx. We're tracking this work with #72.

dnlosx

comment created time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha 8b1a8a1af967750ead82a15950c52aff5d26c19f

Add changelog entry for #153

view details

push time in 4 days

delete branch SwiftDocOrg/swift-doc

delete branch : fix-relationship-graph-links

delete time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha aade6f98ae53d2ef8ff7b444d8f04830116dca7f

Add missing links for nodes in relationship graph (#153)

view details

push time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha f83e8984e9dee76cdba10acf930d292cf49b8935

Fix visual regression for adjacent linked tokens in code block (#152) * Fix visual regression for adjacent linked tokens in code block * Add changelog entry for #152

view details

Mattt

commit sha 359d0bdb5eac292e500e77415f948dea5ee8d576

Merge branch 'master' into fix-relationship-graph-links

view details

push time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha f83e8984e9dee76cdba10acf930d292cf49b8935

Fix visual regression for adjacent linked tokens in code block (#152) * Fix visual regression for adjacent linked tokens in code block * Add changelog entry for #152

view details

push time in 4 days

issue closedSwiftDocOrg/swift-doc

Typealias with generic right-hand side overlaps self

A typealias to a generic right-hand side overlaps itself as shown here:

Screen Shot 2020-07-02 at 1 25 15 PM

I think it has to do with this CSS rule:

.highlight {
    text-indent: -2em;
}

closed time in 4 days

a2

issue commentSwiftDocOrg/swift-doc

Typealias with generic right-hand side overlaps self

@a2 Thanks again for submitting this, Alexsander. And thanks also for sharing swift-shortcuts — thanks to its size and interconnectedness, it's a great project to test and benchmark swift-doc. In fact, I discovered a regression in the course of investigating this (#153), which I'm very happy to have in for the forthcoming release.

a2

comment created time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha 78a57cbaf5703591edd80fc85da15f8753845aa9

Add changelog entry for #152

view details

push time in 4 days

create barnchSwiftDocOrg/swift-doc

branch : fix-relationship-graph-links

created branch time in 4 days

create barnchSwiftDocOrg/swift-doc

branch : fix-adjacent-links-in-declaration

created branch time in 4 days

delete branch SwiftDocOrg/swift-doc

delete branch : verify-internal-members-hidden

delete time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha 00f2787e36675d6f3212e83b7ecb1e5fbc8f461d

Add test that non-public members aren't included in generated documentation (#151) Verifies #136

view details

push time in 4 days

issue commentSwiftDocOrg/swift-doc

documented only some pods

This feature is tracked by #72.

khaledbohout2

comment created time in 4 days

issue closedSwiftDocOrg/swift-doc

documented only some pods

hey, it worked for me and generated this html file which is probably documentation for some pods and third party libraries and can not find any of my classes (models, view , presenters) , i even searched for some code in the documentation and could not find it in my code

image

closed time in 4 days

khaledbohout2

create barnchSwiftDocOrg/swift-doc

branch : verify-internal-members-hidden

created branch time in 4 days

GollumEvent

issue closedSwiftDocOrg/swift-doc

SwiftDoc only generates documentation for some non-public members

It seems that SwiftDoc only generates documentation for public types but I have noticed that some non-public members are sometimes still generated:

  1. internal nested type has an entry on the public parent type's page but the destination is a 404
  2. internal properties on public types
  3. internal initializers on public types
public struct MyStruct: Encodable {
    enum CodingKeys: String, CodingKey { // [1]
        case value = "Value"
    } 

    let value: String // [2]

    init(value: String) { // [3]
        self.value = value
    }
}

closed time in 4 days

a2

issue commentSwiftDocOrg/swift-doc

SwiftDoc only generates documentation for some non-public members

Fixed by #131.

a2

comment created time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha aeed63c32484dc298bd12accc087b1c65ecb8b0d

Add zero width space to escape emoji shortcodes (#149) * Add zero width space to escape emoji shortcodes * Add changelog entries for #149

view details

push time in 4 days

issue closedSwiftDocOrg/swift-doc

`on:` parameters rendering with some kind of emoji

See here: https://github.com/candor/sublimate/wiki/SublimateModelMiddleware

As an aside: good tool.

closed time in 4 days

mxcl

push eventSwiftDocOrg/swift-doc

Mattt

commit sha 7bdcbc5e798d57c6ba5b9667262e5b7759eab4f5

Omit initializer expression if closure or function call to ensure sonable declaration code blocks (#150) * Omit initializer expression if closure or function call to ensure reasonable declaration code blocks. Resolves #138 * Add changelog entry for #150

view details

Mattt

commit sha 26cc65aaa3f217df08d80f2666d1adb4ccf90286

Merge branch 'master' into prevent-emoji-shortcodes

view details

push time in 4 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha 7bdcbc5e798d57c6ba5b9667262e5b7759eab4f5

Omit initializer expression if closure or function call to ensure sonable declaration code blocks (#150) * Omit initializer expression if closure or function call to ensure reasonable declaration code blocks. Resolves #138 * Add changelog entry for #150

view details

push time in 4 days

issue closedSwiftDocOrg/swift-doc

Inline-assigned property has no displayed type

image

The following renders as above without the Bool type displayed:

var allowsEncodingAsPlainString = true

closed time in 4 days

a2

push eventSwiftDocOrg/swift-doc

Mattt

commit sha cbf4284e665604bc0149f61d76614128778a0c5c

Add changelog entry for #150

view details

push time in 5 days

issue commentSwiftDocOrg/swift-doc

Inline-assigned property has no displayed type

This is a regression caused by https://github.com/SwiftDocOrg/swift-doc/commit/93b33c1b20b95ea354e0b9f3b9bce6a9717363a4#diff-4082294eb6d0c0415becf026802c8cfcR188. To fix the immediate problem, I have a patch in #150 that only omits initializer clause if its a closure or function call expression. conventional literal expressions (boolean, integer, floating-point, string, array, dictionary, etc.) will now be shown.

a2

comment created time in 5 days

push eventSwiftDocOrg/swift-doc

Mattt

commit sha e883acba620e25cabf2ba0651639405d007160fa

Add changelog entries for #149

view details

push time in 5 days

issue commentSwiftDocOrg/swift-doc

`on:` parameters rendering with some kind of emoji

Aside: Sublimate looks cool! I've likewise found Vapor's use of Futures to be a pain point, and look forward to giving this a try.

mxcl

comment created time in 5 days

issue commentSwiftDocOrg/swift-doc

`on:` parameters rendering with some kind of emoji

What is this, a vBulletin forum from the '00s? I don't think I'll ever understand the motivation behind emoji shortcodes...

Anyway, I found what appears to be a minimally-invasive workaround in appending zero-width spaces after each occurrence of a colon. See #149.

Before

Screen Shot 2020-07-31 at 05 56 54

After

Screen Shot 2020-07-31 at 05 57 56

mxcl

comment created time in 5 days

create barnchSwiftDocOrg/swift-doc

branch : prevent-emoji-shortcodes

created branch time in 5 days

issue commentSwiftDocOrg/swift-doc

lib_InternalSwiftSyntaxParser error on Xcode exec run

Hi @KillianSmith0. This issue is discussed in #60, with a workaround suggested by @kean to set the DYLD_LIBRARY_PATH environment variable.

KillianSmith0

comment created time in 5 days

push eventNSHipster/SwiftSyntaxHighlighter

David Strehlow

commit sha e57888b2b42f1a64884b254f59f44ec860a21a3a

two corrections

view details

push time in 5 days

PR merged NSHipster/SwiftSyntaxHighlighter

Two small corrections to punctuation.

Two small corrections that were needed to make the examples in README.md work correctly. Odd that the mismatched quotes got in there in the first place.

+2 -2

1 comment

1 changed file

dstrehlow

pr closed time in 5 days

pull request commentNSHipster/SwiftSyntaxHighlighter

Two small corrections to punctuation.

Hey, thanks for this PR @dstrehlow. Apologies for not merging this in sooner.

dstrehlow

comment created time in 5 days

startedruby/rbs

started time in 6 days

issue commentSwiftDocOrg/swift-doc

Github Action Consistently breaks

#146 is now merged. @ApplebaumIan Please let me know if you're still seeing this issue.

ApplebaumIan

comment created time in 6 days

Pull request review commentpointfreeco/swift-composable-architecture

Add swift-doc action

+name: Documentation+on:+  release:+    types:+      - published+jobs:+  build:+    runs-on: ubuntu-latest++    steps:+      - uses: actions/checkout@v2+      - name: Generate Documentation+        uses: SwiftDocOrg/swift-doc@master+        with:+          base-url: /swift-composable-architecture/+          format: html+          inputs: Sources/ComposableArchitecture+          module-name: ComposableArchitecture+          output: Documentation+      - name: Update Permissions+        run: 'sudo chown --recursive $USER Documentation'

@stephencelis Done!

stephencelis

comment created time in 6 days

push eventSwiftDocOrg/swift-doc

Yoshimasa Niwa

commit sha 2f79e9797ed6b2b2dddfd936a1fd4c3516d485a7

FIX: swift-doc creates file and directory with unexpected permission (#146) * FIX: swift-doc creates file and directory with unexpected permission **Problem** swift-doc creates file with execution bit, also creates directory without execution bit. **Solution** Remove unexpected permission attributes given to the `FileManager` and let them to use file system defaults. * Update changelog.

view details

push time in 6 days

PR merged SwiftDocOrg/swift-doc

FIX: swift-doc creates file and directory with unexpected permission

Problem

swift-doc creates file with execution bit, also creates directory without execution bit.

Solution

Remove unexpected permission attributes given to the FileManager and let them to use default permission respects file system and process umask.

+5 -8

2 comments

5 changed files

niw

pr closed time in 6 days

more