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

Swift Docs: List all topic titles and language features to help measure coverage #509

Closed
4 tasks
MariagraziaAlastra opened this issue Nov 3, 2016 · 8 comments

Comments

@MariagraziaAlastra
Copy link
Member

MariagraziaAlastra commented Nov 3, 2016

Description

For every Fathead, we need to gather the set of articles we wish to provide coverage for.
Create a cover/ directory containing text files that list all the topic titles and language features to cover.
These lists will then be used as Unit tests to help you measure the Fathead's coverage.
For more info please see the docs.

Get Started

Resources


Instant Answer Page: https://duck.co/ia/view/swiftdocs

@tagawa tagawa changed the title Swift Docs: add coverage data Swift Docs: List all topic titles and language features to help measure coverage Nov 30, 2016
@tagawa
Copy link
Collaborator

tagawa commented Dec 2, 2016

Just to clarify, this issue requires making a list of keywords in a new text file - no coding is needed.
As an example, there are two similar pull requests for other languages which should be useful for reference:

@altern8tif
Copy link

@tagawa sign me up for this.

Just to clarify, are the .txt files used for tests in t/validate_fathead.t file? Are the topic titles/language features meant to be generated manually?

@tagawa
Copy link
Collaborator

tagawa commented Jan 3, 2017

Hi @altern8tif (and happy new year!). Thank you for taking this up. Yes, the .txt files will be used for tests. Because of this, the topic titles/language features should be generated manually. This could be by scraping from the official docs, for example. Ideally the Fathead will already cover everything in the generated lists but doing it manually in this way will enable us to verify it.

@altern8tif
Copy link

@tagawa noticed that the current fathead implementation is for Swift 2.2. Should I be generating the .txt file for Swift 3 instead?

@pjhampton
Copy link
Contributor

pjhampton commented Feb 8, 2017

Sorry for the late reply, @altern8tif. Yes, please!
I'm about to create an issue for someone to update the source from 2.2 -> 3

@altern8tif
Copy link

@pjhampton sweet, thanks! Will send a PR across soon.

@altern8tif
Copy link

Noticed that the update to Swift 3.1 is held up (#790). I'll hold off till that's resolved first.

@pjhampton
Copy link
Contributor

Hey @MariagraziaAlastra

DuckDuckHack is now in Maintenance Mode and from now on, we are only accepting issues and PRs for essential bugs and bug fixes.

Unfortunately, with the above in mind, this isn't something we can action and will be closed.

We appreciate you taking the time to contribute and apologize for not being able to triage this issue.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

5 participants