question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Technical Documentation Project - Test Error

See original GitHub issue

I’ve been streaming going through the freeCodeCamp curriculum, and came across a bug today.

https://learn.freecodecamp.org/responsive-web-design/responsive-web-design-projects/build-a-technical-documentation-page

During this project, the user story for User Story #4: Each section element with the class of main-section should also have an id that corresponds with the text of each header contained within it. Any spaces should be replaced with underscores (e.g. The section that contains the header "Javascript and Java" should have a corresponding id="Javascript_and_Java").

When adding in content for my sections, sometimes there was punctuation in the title. When the tests run, they fail if I’ve taken the punctuation out of the slugs I’ve created.

freecodecamp-responsiveweb

It would probably be helpful to add some content to the user story letting people know not to use punctuation in class and id names, and to have the test parse out the punctuation when users are creating the url slugs for their links.

Tell us about your browser and operating system

  • Browser Name: Chrome
  • Browser Version: Version 68.0.3440.106 (Official Build) (64-bit)
  • Operating System: Windows 10 Home

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:1
  • Comments:7 (5 by maintainers)

github_iconTop GitHub Comments

2reactions
akmalistcommented, Sep 16, 2018

Same thing here. Had to remove ** ? ** on my titles.

https://codepen.io/akmalist/pen/GXXQmd

1reaction
tbushmancommented, Feb 21, 2019
Read more comments on GitHub >

github_iconTop Results From Across the Web

Issue with test in technical documentation project - HTML-CSS
Tell us what's happening: not passing this test in the technical documentation project. Each .main-section should have an id that matches ...
Read more >
Test Documentation in Software Testing (Example) - Guru99
A high-level document which identifies the Test Levels (types) to be executed for the project. Test plan, A test plan is a complete...
Read more >
Technical Documentation in Software Development - AltexSoft
The common examples of process-related documents are standards, project documentation, such as project plans, test schedules, reports, meeting ...
Read more >
Testing your Documentation - Write the Docs
The most useful tests are run on each commit of your project. ... Most tools will return an error code of 0 if...
Read more >
Importance of Documenting Frequently Encountered Errors
This Scenario Explains How Important It is to Document the Frequently Encountered Errors · Some of the areas with frequent errors: · Download ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found