Giter VIP home page Giter VIP logo

docs's Introduction

CS50 Docs

Build Status

Usage

  1. Edit _pages/*.
  2. git add PATH [PATH]
  3. git commit
  4. git push
  5. View http://docs.cs50.net/path/to/file.html after a few seconds.

If your changes do not affect the rendered files under _site/ (e.g., changes to .gitignore), be sure to include [skip ci] in the message of the last commit before you push to avoid triggering a build, which would fail, as there would be no changes to deploy.

Viewing Changes Locally

  1. Install Docker Engine.
  2. sudo pip install cli50
  3. cd docs
  4. cli50
  5. make
  6. View _site/*.

docs's People

Contributors

annieechen avatar aternus avatar benedictbrown avatar blauelf avatar brianyu28 avatar cmlsharp avatar coderigo17 avatar coltonoscopy avatar curiouskiwi avatar daveyproctor avatar dcorkran avatar dlloyd09 avatar dmalan avatar ehhong avatar erin-c avatar guymelef avatar hirschhorn avatar kzidane avatar moughamir avatar natmelo avatar spencertiberi avatar therijn avatar ummcheng avatar veronicanutting avatar xctrunner avatar youssef1313 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Can't submit extra files as needed

re: SPELLER problem:

You may add functions to dictionary.c or to files of your own creation so long as all of your code compiles via make.

If a student does create these files and creates their own Makefile, they might figure out that check50 can still run by including those extra files as part of the command line args. But, submit50 does not allow them to submit any additional files, so the grading will fail.

Files that will be submitted:
Makefile
dictionary.c
dictionary.h
questions.txt
speller.c

Should we be advising students not to use extra files instead?

Some Latex formatting is missing ( caesar , vigenere)

In the caesar and vigenere problem docs, I see:

\[c_i = (p_i + k_j) \bmod 26\]

rather than a formatted version.

I also notice in my console that I get
/extensions/MathMenu.js?V=2.7.1
Failed to load resource: the server responded with a status of 404 (Not Found)
/extensions/MathZoom.js?V=2.7.1
Failed to load resource: the server responded with a status of 404

Not sure if that's related.

Broken link at whodunit pset4

Hello guys!

I was trying to access a link referred by whodunit at problem set 4.

It happens that the link is returning a 400 bad request response, and with it, leaking some information about the webserver.

screenshot from 2017-09-22 11-09-54

I also tried to issue the request via command line HTTP client and also had the same result.

I hope you guys fix the docs if the link doesn't exist or fix it, so people in the future doesn't get frustrated or so.

I also recommend you to remove the server HTTP header response.

See you guys out there!

Confusing Flash instructions in Problem Set 0

Hi there! I'm a new student, and when I went to follow the instructions to make sure Flash was enabled in Chrome, I got a bit confused. I think the instructions as they are in the problem set are a bit out of date: https://docs.cs50.net/2018/x/psets/0/pset0.html#tldr

Right now it reads:
"Make sure that your web browser has Flash enabled. If you’re using Google Chrome, you can go to chrome://settings/content, click on Advanced → Content settings, and make sure you "allow" Flash!"

To make this more clear to future students with less experience (like me!) I'd suggest revising to:
"Make sure that your web browser has Flash enabled. If you're using Google Chrome, you can type chrome://settings/content in your browser, then scroll down to the "Flash" section. Make sure "Ask First" is enabled so you can allow Flash to run when you're using Scratch."

Thank you!
Kimberlee

There's a mistake in Problem Set 2 page

In the advice section in pset2, there's a sentence going like this:

For instance, if trying to compile hello, and
make readability
is yielding errors, try running
help50 make readability
instead!

The word "hello" on the first line should be changed to "readability".

Make no longer gives the "<program> is up to date" message. Specs need to be changed to reflect?

In the Find problem, this paragraph no longer fully applies:

The first line tells make that the "target" called generate should be built by invoking the second line’s command. Moreover, that first line tells make that generate is dependent on generate.c, the implication of which is that make will only re-build generate on subsequent runs if that file was modified since make last built generate. Neat time-saving trick, eh? In fact, go ahead and execute the command below again, assuming you haven’t modified generate.c.

 make generate

You should be informed that generate is already up-to-date.

(note that this also applies to the https://cdn.cs50.net/2016/x/psets/3/pset3/pset3.html spec, and has raised questions from edX students).

time to debug

I have watched the "Week 1 : C" and am doing the Pset1.

  • problems/credit.adoc#L109 (or alternatively ~/psets/1/credit) says "... time to debug!"
  • but debugging is not covered in the course so far.
  • is this ommission intentional?
  • any suggested resource for learning how to debug?

Google (or perhaps a roommate's wallet) should turn up more. (If your roommate asks what you're doing, don't mention us.) If your program behaves incorrectly on some inputs (or doesn't compile at all), time to debug!

PSet8 documentation for Google News needs updating

A few notes:

questions.txt no longer in Whodunit distro code - causing confusion

For the Whodunit problem, you are asked: "In questions.txt, answer each of the following questions in a sentence or more."

Folks are asking where questions.txt is. I've been telling them to create it themselves and save it in their whodunit folder (which I thought might be obvious, but perhaps we should add a line of instruction saying this?)

Update edX submission instructions

When we debut the new check50 and integrate it with CS50.me, we'll need to...

For pset6, replace the submit50 slug cs50/2017/x/pset6 with:

  • C-to-Python slugs:
    • cs50/2017/x/python/mario/less
    • cs50/2017/x/python/mario/more
    • cs50/2017/x/python/greedy
    • cs50/2017/x/python/credit
    • cs50/2017/x/python/caesar
    • cs50/2017/x/python/vigenere
    • cs50/2017/x/python/crack
  • Sentiments slugs:
    • cs50/2017/x/smile
    • cs50/2017/x/tweets
    • cs50/2017/x/sentiments

For pset0, if we're going to have students submit via GitHub:

  • instructions for creating a cs50/2017/x/scratch branch, and uploading their .sb file.

For all psets:

  • mandate the cs50/ prefix if we're going to get rid of the assumption of cs50/ at the beginning

CC @dmalan @crossroads1112

edX submission instructions

There are inconsistencies between the submission instructions vs subfolder creation instructions on the edX pset1.

Summary:
On pset1.html, it requests that students create the C files under ~/workspace/pset1 folder. However, the instructions on specific assignments, such as hello.html states that students should create a pset1/hello/ subfolder while instructions on other assignments such as water.html states that the C file should be created under the pset1/ folder. Unfortunately this causes some of the submission instructions on the pset1.html page to be incorrect.

The following submission instructions could use update to reflect the instructions on each assignment:

  • hello.html instructs students to create folder pset1/hello/. If true, the submission instruction for hello on pset1.html should be updated to cd ~/workspace/pset1/hello/.

  • less/mario.html instructs students to create folder pset1/mario/less/. If true, the submission instruction for less-comfortable version of mario on pset1.html should be updated to cd ~/workspace/pset1/mario/less/.

  • more/mario.html instructs students to create folder pset1/more/. If true, the submission instruction for more-comfortable version of mario on pset1.html should be updated to cd ~/workspace/pset1/more/. Additionally, I would like to point out the inconsistency in folder naming between less and more comfortable versions of mario.

  • credit.html instructs students to create folder pset1/credit/. If true, the submission instruction for credit on pset1.html should be updated to cd ~/workspace/pset1/credit/.

The following submission instructions work correctly, but the folder creation instructions are inconsistent with the rest of the pset1 assignments:

  • water.html does not request for students to create a pset1/water subfolder

  • greedy.html does not request for students to create a pset1/greedy subfolder.

pset5 walkthroughs may be put in a more logical order

docs/_pages/2018/spring/psets/5/speller/speller.adoc

The playlist for the walkthroughs is currently: speller -> check -> load -> unload.

This should probably be: speller -> load -> check -> unload, as "load" contains elaborate info on the data structure that is referenced in check.

Wrong API URL in CS50 Finance

In the CS50 Finance problem, following the API URL example with a valid API key leads to an error:

Indeed, IEX lets you download stock quotes via their API (application programming interface) using URLs like https://cloud-sse.iexapis.com/stable/stock/nflx/quote?token=API_KEY.

Looking at the documentation on IEX, the SSE endpoint is only available for paid users. I believe the correct URL should be https://cloud.iexapis.com/stable/stock/nflx/quote?token=API_KEY (cloud-sse -> cloud), which is used in the problem distribution code.

./find TODO

In both the more & less versions of the Find problem, the Usage section simply says:

Your program should behave per the examples below. Assumed that the underlined text is what some user has typed.

$ ./find TODO

Seems there's something missing.

Yahoo Finance API endpoint service was discontinued

Unfortunately, Yahoo Finance API endpoint http://download.finance.yahoo.com/d/quotes.csv mentioned in https://github.com/cs50/docs/blob/d874daaf91ac96fbc64ae3be39b6d7ce3a59591b/_pages/problems/finance/finance.adoc#background and used by lookup() function in finance/helpers.py of Problem Set 7 is no longer available. download.finance.yahoo.com doesn't even resolve. Here is post by Yahoo support staff member which says:

UPDATE: It has come to our attention that this service is being used in violation of the Yahoo Terms of Service. As such, the service is being discontinued. For all future markets and equities data research, please refer to finance.yahoo.com. Thank you.

Preceding dollar sign ($) and copy paste (UX Issue)

On pages like http://docs.cs50.net/problems/fifteen/fifteen.html when there is a $ preceding a command, it would be helpful to format it in a way as to not copy paste the $ .

You could consider an approach like Digital Ocean uses in their tutorials:
https://www.digitalocean.com/community/tutorials/how-to-install-moodle-on-ubuntu-16-04

Alternatively, we could just remove the dollar signs. Other places in the docs are already this way. (See http://docs.cs50.net/2017/x/psets/5/pset5.html for examples).

HTML project contribution

Is it possible to work and contribute to html projects for cs50 within Github or do I need to download the files to my local drive and work within there? Thanks

Mario [more comfortable] - hints

sir,
The pset1 mario more for more comfortable people doesn't have a key hint regarding the use of \n.
please, consider the following case
case no:1 : check50 marks this solution incorrect.
height:4
0123456789

    • # # * *\n //new line is printed after 9.
    • ##* *\n

  • ###*\n

####\n

case no: 2 : check50 marks this solution correct.
height:4
0123456789

      • #\n //new line is printed after the right-most hash.

    • ##\n

  • ###\n

####\n

Both the solutions are equally correct, I have seen many people on cs50 asking why their solution is incorrect and wasting their time on this silly mistake which is easy to solve when informed.
A hint should be there that you don't have to print spaces after the right-most hash. A \n should be used.
thanks!

Pset 1 : Mario.more hints!

sir,
The pset1 mario more for more comfortable people doesn't have a key hint regarding the use of \n.
please, consider the following case
case no:1 : check50 marks this solution incorrect. consider ~ for spaces.

   height:4
   0123456789
   ~~~#~~#~~~\n                // new line is used after the length of row.ie (height*2)+2
   ~~##~~##~~\n
   ~###~~###~\n
   ####~~####\n

case no: 2 : check50 marks this solution correct. consider ~ for spaces.

  height:4
  0123456789
  ~~~#~~#\n                           // New line is used after the rightmost hash!
  ~~##~~##\n
  ~###~~###\n
  ####~~####\n

Both the solutions are equally correct, I have seen many people on cs50 group asking why their solution is incorrect and wasting their time on this silly mistake which is easy to solve when informed.
A hint should be there that you don't have to print spaces after the right-most hash. A \n should be used.
thanks!

Students assume 50 jpgs and hard-code their loops which then fail check50

The spec explicitly says

But you should ultimately find that the image contains 50 JPEGs.

This leads many students to assume they should hard-code their number of jpgs to 50 and structure their program this way (with a for loop that ends when 50 jpgs are found). This works perfectly fine with the card.raw that is in the distro code, but check50 uses a different raw file (with only 16 files) so their program is then "killed by server" because it never finds the 17th signature and goes into an infinite loop.

Should we add something like:

Note that your program may be tested with a different card image so you should not hard-code that number, but instead, search the entire file for all the JPEGs within it.

PSET4 - Recover, Additional error case?

I beg a pardon if this is not apropriate place to ask such questions, but unfortunatelly i can't find more appropriate place to ask it.

In Problem Set 4, Specifications described only 2 error states:

  1. Your program should accept exactly one command-line argument, the name of a forensic image from which to recover JPEGs. + If your program is not executed with exactly one command-line argument, it should remind the user of correct usage, as with fprintf (to stderr), and main should return 1.

  2. If the forensic image cannot be opened for reading, your program should inform the user as much, as with fprintf (to stderr), and main should return 2.

Aren't we suppose also to return error (let's say with a code 3), in case if program can't create a restored image file. Here is a code i am talking about that cover this missing note

whodunit... we no longer ask

When submitting this problem, you’ll be asked whodunit!

Now that we've removed the step 2 form from the submission, we no longer ask whodunit.

Maybe we should add this to the README.md as the last question? and tell them to come back and answer it once they've found out?

"more" sort hint says to use O(n^2) algorithm?

Looks like the "more" hint for the sort part of find was copy/pasted from the "less" hint, as it says to make sure you use an O(n^2) sort method, yet the problem requires a O(n) solution.

libz-dev for nokogiri?

An error occurred while installing nokogiri (1.8.3), and Bundler cannot continue.
sudo apt-get install libz-dev

minor week 8 inconsistencies

Seems there are a few minor differences between the code shown in lecture the code shown in the notes for Week 8, pointed out by an online student:

  • Lecture code for application.py with froshIMs seems to be a superset of the code shown in lecture, which may be okay in the interest of giving students more info rather than less, but an example is that there's a missing conditional for "captain" in the lecture code, whereas it shows up in notes.
  • store.html seems to be omitted from the notes during the shopping cart section.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.