Comments (9)
Hey! ๐ As part of the Swift Mentorship Program and with the help of my mentor, I'm hoping to make my first contribution to an open-source project. I would love to give this issue a try! ๐
from swift-docc.
That's great to hear. Feel free to reach out if you have any questions.
from swift-docc.
Thanks for the advice! I just opened a draft PR #391, I look forward to your feedback!
from swift-docc.
@swift-ci create
from swift-docc.
To implement what's described in the Description there are few different places to look at:
The display name and identifier decoded in init(with:bundleDiscoveryOptions:
in DocumentationBundle+Info.swift
That's a good place to default to the display name when the identifier is missing. Depending on this the decoding is done, requiredKeys
may also need to change.
That code doesn't know what the DocC catalog is named or what the modules are namedโthey know the symbols graph URLs but would need to read and decode the files to find the module nameโso the last resort derived display name would need to be passed there or otherwise be made accessible somehow.
There are different code paths for creating documentation "bundles" when there's a DocC catalog and when there isn't.
When there's a DocC catalog the code path that creates the bundle is in createBundle(::options๐
in DataProviderBundleDiscovery.swift
When there's no DocC catalog the bundle is created in GeneratedDataProvider
. It also has some code to read the module names out of the symbol graph files.
DocumentationBundleInfoTests
tests the existing decoding (which would be updated to cover the logic for deriving values) but it could also be good to test the full flow in ConvertActionTests
by passing a few different variations of bundle discovery options both with and without a DocC catalog (the documentationBundleURL:
argument to ConvertAction
from swift-docc.
Hi @arthurcro, are you still working on this? Let us know we can help!
(This is indeed a annoying issue for the user site, and hope we can solve it ASAP)
from swift-docc.
Hey @Kyle-Ye! My apologies for the delay in closing this issue. I actually have something working on a fork but I got stuck adding a test covering the full flow in ConvertActionTests
and I haven't had the opportunity to pick it up again. I'm not quite sure how to get started adding a test there. I'd love some help with this if you have time! ๐
from swift-docc.
Hey @Kyle-Ye! My apologies for the delay in closing this issue. I actually have something working on a fork but I got stuck adding a test covering the full flow in
ConvertActionTests
and I haven't had the opportunity to pick it up again. I'm not quite sure how to get started adding a test there. I'd love some help with this if you have time! ๐
Would you mind pointing out which branch you were working? If I guess correctly, should it be https://github.com/arthurcro/swift-docc/tree/arthurcro/improve-deriving-cli-arguments
from swift-docc.
I'd love some help with this if you have time!
Maybe you can start to create a draft PR. So that we can comment on it and give you some feedback
from swift-docc.
Related Issues (20)
- Pass "link summaries" instead of "resolved information" in external documentation source responses
- Can't document - -= / /= operators HOT 8
- DocC generates inconsistent output for global Objective-C functions that are renamed to be associated with a type in Swift HOT 2
- Error when publishing to GitHub Pages HOT 6
- Linkable glossary
- Document Objective-C extensions with DocC HOT 2
- Xcode "Build documentation" not working with Swift Macro package in project HOT 5
- Curating a module under a technology root causes the sidebar to not show Objective-C symbols
- illegal hardware instruction HOT 4
- This mangled quote/code fence results in a crash HOT 1
- `@DeprecationSummary` directive doesn't always have an effect HOT 2
- Xcode does not provide fix for operator functions HOT 4
- Make DocC-Generated Website Indexable by Search Engines HOT 2
- Slices of Snippets don't have indentation removed HOT 1
- optional force unwrap fails if target name contains special characters
- Snippet slicing does not handle multiline string literals correctly
- Migrate to Swift 6
- Deprecated Objective-C methods not being marked as Deprecated
- Add `*` support for `@Available` directive HOT 2
- Remove duplicate semantic versioning types HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from swift-docc.